openkeepd/README.md

58 lines
1.1 KiB
Markdown
Raw Normal View History

2019-10-12 13:44:48 +00:00
# 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 clone of Google Keep note-taking service (server-part)
2019-10-12 13:44:48 +00:00
`TODO: Fill out this long description.`
2019-10-12 14:02:57 +00:00
**Features**:
- [ ] Account system (username/password/display name/avatar)
- [ ] Plain-text notes
- [ ] Note synchronization across many clients
- [ ] Note sharing
- [ ] TODO-lists
- [ ] WYSIWYG notes
- [ ] Pin notes
- [ ] Attach media to notes
- [ ] Tagging notes
2019-10-12 13:44:48 +00:00
## 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