Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
andymerskin authored Jul 19, 2017
1 parent 5521d84 commit e5283d3
Showing 1 changed file with 18 additions and 6 deletions.
24 changes: 18 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,34 @@
# spriggan
# Spriggan

> An electron-vue project
> The Celtic batch sprite generator. Created with love at Markit Digital.
<p align="center">
<img src="https://github.com/docmars/spriggan/blob/master/resources/spriggan.gif" alt="Spriggan Demo Gif"/>
</p>

#### 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).

0 comments on commit e5283d3

Please sign in to comment.