README.md

Crimp

A mac app for asset optimization and compression

---

Installation

Crimp is currently in beta. Please feel free to report any bugs or error you may come across.

_{v0.2.0 Beta}

 

Contributing

Crimp is built on web technologies using Electron and React. Incase, you wish to contribute please submit a Issue first outlining the changes you would like to make.

Development setup

1. Clone Github repo $ git clone https://github.com/ghosh/Crimp.git
2. Install yarn package manager, if you don't have it already (Read installation guide)
3. Run yarn install in the root folder to install all dependencies
4. Run yarn start to start the local electron app. This comes with Hot Module Replacement for react for instant changes.

Test your changes by compiling the app via

yarn package

 

Licensing

This project is licensed under MIT license.

 

Made by

Indrashish Ghosh – @_ighosh 🇮🇳