Skip to content

Commit

Permalink
Docs (#30)
Browse files Browse the repository at this point in the history
  • Loading branch information
ruslansavenok authored Jan 9, 2019
1 parent ccbc0de commit cb10fe6
Showing 1 changed file with 29 additions and 2 deletions.
31 changes: 29 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,32 @@
# 10Books

**10Books** is a workplace library managment software built on top of [Phoenix Framework](https://phoenixframework.org/).
10Books is a workplace library managment software built on top of [Phoenix Framework](https://phoenixframework.org/).

![10Books screenshot](https://dl.dropboxusercontent.com/s/xakzy76pg8crudu/app-screenshot.png)
<p align="center">
<img src="https://dl.dropboxusercontent.com/s/xakzy76pg8crudu/app-screenshot.png" />
Try the <a href="http://live-demo-url.com">Live Demo</a>
</p>

## Features
##### For reader:
* Search books by title, category or author
* See which books are available
* Get notified when books are returned
* Suggest a book to order
* Vote for other people order suggestions
##### For administrator:
* See who and when borrowed book
* Know which books to order with vote based whishlist
* Automatic email reminders if book is not returned on time
* Edit book information
* Manage book status: "In Libray", "In Voting", "Ordered", "Lost"

## Getting started
* Try the [Live demo](http://live-demo-url.com)
* Follow [Installation guide](https://github.com/10clouds/10Books/wiki/Installation-guide)

## Want to contribute?
Roadmap coming soon...

### Built with ❤️ at 10Clouds
https://10clouds.slack.com/archives/CAV93NQFM/p1547059932001100 in progress

0 comments on commit cb10fe6

Please sign in to comment.