diff --git a/README.md b/README.md index 9f14a8b..d4bcbd2 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,34 @@ -# spriggan +# Spriggan -> An electron-vue project +> The Celtic batch sprite generator. Created with love at Markit Digital. + +

+ Spriggan Demo Gif +

+ +#### Usage +1. Drag images, or folders of images you want to create sprites out of. +2. Click **Generate All**. +3. Sing a Gaelic tune! #### Build Setup ``` bash # install dependencies -npm install +yarn # serve with hot reload at localhost:9080 -npm run dev +yarn run dev # build electron application for production -npm run build - +yarn run build ``` +#### License + +MIT + --- This project was generated with [electron-vue](https://github.com/SimulatedGREG/electron-vue) using [vue-cli](https://github.com/vuejs/vue-cli). Documentation about the original structure can be found [here](https://simulatedgreg.gitbooks.io/electron-vue/content/index.html).