Skip to content

Commit

Permalink
docs: create README
Browse files Browse the repository at this point in the history
  • Loading branch information
charitarthchugh committed Jul 23, 2022
1 parent 4671058 commit d86a38f
Showing 1 changed file with 58 additions and 0 deletions.
58 changes: 58 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@

![Logo](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/th5xamgrr6se0x5ro4g6.png)


# Bookie

A brief description of what this project does and who it's for


## Badges

Add badges from somewhere like: [shields.io](https://shields.io/)

[![MIT License](https://img.shields.io/apm/l/atomic-design-ui.svg?)](https://github.com/tterb/atomic-design-ui/blob/master/LICENSEs)


## Features

- Light/dark mode toggle
- Live previews
- Fullscreen mode
- Cross platform


## Installation

Install my-project with npm

```bash
npm install my-project
cd my-project
```

## Tech Stack

**Client:** Flutter

**Server:** FastAPI & SQLite


## Running Tests

To run tests, run the following command

```bash
poetry shell
pytest
```


## API Reference



## License

[MIT](https://choosealicense.com/licenses/mit/)

0 comments on commit d86a38f

Please sign in to comment.