Update README (#858)

Reviewed-on: https://kolaente.dev/vikunja/api/pulls/858
Reviewed-by: konrad <konrad@kola-entertainments.de>
Co-authored-by: earnest ma <me@earne.link>
Co-committed-by: earnest ma <me@earne.link>
This commit is contained in:
earnest ma 2021-05-11 18:14:35 +00:00 committed by konrad
parent d69482cda9
commit fc1867ec70

View file

@ -5,7 +5,7 @@
[![Download](https://img.shields.io/badge/download-v0.16.1-brightgreen.svg)](https://dl.vikunja.io) [![Download](https://img.shields.io/badge/download-v0.16.1-brightgreen.svg)](https://dl.vikunja.io)
[![Docker Pulls](https://img.shields.io/docker/pulls/vikunja/api.svg)](https://hub.docker.com/r/vikunja/api/) [![Docker Pulls](https://img.shields.io/docker/pulls/vikunja/api.svg)](https://hub.docker.com/r/vikunja/api/)
[![Swagger Docs](https://img.shields.io/badge/swagger-docs-brightgreen.svg)](https://try.vikunja.io/api/v1/docs) [![Swagger Docs](https://img.shields.io/badge/swagger-docs-brightgreen.svg)](https://try.vikunja.io/api/v1/docs)
[![Go Report Card](https://goreportcard.com/badge/git.kolaente.de/vikunja/api)](https://goreportcard.com/report/git.kolaente.de/vikunja/api) [![Go Report Card](https://goreportcard.com/badge/kolaente.dev/vikunja/api)](https://goreportcard.com/report/kolaente.dev/vikunja/api)
# Vikunja API # Vikunja API
@ -28,7 +28,7 @@ If you find any security-related issues you don't want to disclose publicly, ple
* Create TODO lists with tasks * Create TODO lists with tasks
* Reminder for tasks * Reminder for tasks
* Namespaces: A "group" which bundels multiple lists * Namespaces: A "group" which bundles multiple lists
* Share lists and namespaces with teams and users with granular permissions * Share lists and namespaces with teams and users with granular permissions
* Plenty of details for tasks * Plenty of details for tasks
@ -40,23 +40,22 @@ try it on [try.vikunja.io](https://try.vikunja.io)!
* [Installing](https://vikunja.io/docs/installing/) * [Installing](https://vikunja.io/docs/installing/)
* [Build from source](https://vikunja.io/docs/build-from-sources/) * [Build from source](https://vikunja.io/docs/build-from-sources/)
* [Development setup](https://vikunja.io/docs/development/) * [Development setup](https://vikunja.io/docs/development/)
* [Magefile](https://vikunja.io/docs/mage/) * [Magefile](https://vikunja.io/docs/magefile/)
* [Testing](https://vikunja.io/docs/testing/) * [Testing](https://vikunja.io/docs/testing/)
All docs can be found on [the vikunja home page](https://vikunja.io/docs/). All docs can be found on [the Vikunja home page](https://vikunja.io/docs/).
### Roadmap ### Roadmap
See [the roadmap](https://my.vikunja.cloud/share/QFyzYEmEYfSyQfTOmIRSwLUpkFjboaBqQCnaPmWd/auth) (hosted on Vikunja!) for more! See [the roadmap](https://my.vikunja.cloud/share/QFyzYEmEYfSyQfTOmIRSwLUpkFjboaBqQCnaPmWd/auth) (hosted on Vikunja!) for more!
* [ ] [Mobile apps](https://code.vikunja.io/app) (seperate repo) *In Progress* * [ ] [Mobile apps](https://code.vikunja.io/app) (separate repo) *In Progress*
* [ ] [Webapp](https://code.vikunja.io/frontend) (seperate repo) *In Progress* * [ ] [Webapp](https://code.vikunja.io/frontend) (separate repo) *In Progress*
## Contributing ## Contributing
Fork -> Push -> Pull-Request. Also see the [dev docs](https://vikunja.io/docs/development/) for more infos. Fork -> Push -> Pull-Request. Also see the [dev docs](https://vikunja.io/docs/development/) for more info.
## License ## License
This project is licensed under the AGPLv3 License. See the [LICENSE](LICENSE) file for the full license text. This project is licensed under the AGPLv3 License. See the [LICENSE](LICENSE) file for the full license text.