Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
KeziahMoselle committed Feb 9, 2018
1 parent df0170d commit 4cafe5e
Showing 1 changed file with 24 additions and 9 deletions.
33 changes: 24 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,43 @@
# gelbooru-client
# Gelbooru Client

Electron app for Gelbooru
An Electron app for Gelbooru

[![AppVeyor](https://img.shields.io/appveyor/ci/KeziahMoselle/gelbooru-client.svg?style=for-the-badge)](https://ci.appveyor.com/project/KeziahMoselle/gelbooru-client)
[![GitHub (Pre-)Release Date](https://img.shields.io/github/release-date-pre/KeziahMoselle/gelbooru-client.svg?style=for-the-badge)](https://github.com/KeziahMoselle/gelbooru-client/releases)
[![apm](https://img.shields.io/apm/l/vim-mode.svg?style=for-the-badge)]()

[![Build status](https://ci.appveyor.com/api/projects/status/gfl7he065q83b7eo?svg=true)](https://ci.appveyor.com/project/KeziahMoselle/gelbooru-client)

<img src="/assets/preview.gif">

## Features

* [x] Search images
* [x] Image limit (10,20,50,100)
* [x] 3 cards layout
* [x] Dark & Light mode
* [ ] Save image
* [ ] Rating (Safe or Explicit)

## Installing

```sh
git clone https://github.com/KeziahMoselle/gelbooru-client.git
```

Install dependencies :
```sh
cd gelbooru-client
cd gelbooru-client && npm install
```

To run the app :
```sh
npm install
npm start
```

## Build

```sh
npm start || electron .
npm run build
```
A release folder should be created with all builds and one installer for Windows x64.

## Built With

Expand All @@ -34,4 +49,4 @@ npm start || electron .

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details

0 comments on commit 4cafe5e

Please sign in to comment.