docs: Add README

This commit is contained in:
ChronosX88 2019-10-12 17:44:48 +04:00
parent 1afc88fa37
commit 4602209c37
Signed by: ChronosXYZ
GPG Key ID: 085A69A82C8C511A

46
README.md Normal file
View File

@ -0,0 +1,46 @@
# openkeepd
[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
> A free and opensource alternative to Google Keep service
`TODO: Fill out this long description.`
## Table of Contents
- [Install](#install)
- [Usage](#usage)
- [API](#api)
- [Maintainers](#maintainers)
- [Contributing](#contributing)
- [License](#license)
## Install
```
// TODO
```
## Usage
```
// TODO
```
## API
## Maintainers
[@ChronosX88](https://github.com/ChronosX88)
## Contributing
See [the contributing file](contributing.md)!
PRs accepted.
Small note: If editing the README, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.
## License
MIT © 2019 ChronosX88