mirror of
https://github.com/ChronosX88/openkeepd.git
synced 2024-11-08 19:21:01 +00:00
docs: Add README
This commit is contained in:
parent
1afc88fa37
commit
4602209c37
46
README.md
Normal file
46
README.md
Normal 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
|
Loading…
Reference in New Issue
Block a user