vikunja/README.md

55 lines
2.5 KiB
Markdown
Raw Permalink Normal View History

2019-02-17 19:53:04 +00:00
<img src="https://vikunja.io/images/vikunja-logo.svg" alt="" style="display: block;width: 50%;margin: 0 auto;" width="50%"/>
2018-07-25 21:47:26 +02:00
[![Build Status](https://drone.kolaente.de/api/badges/vikunja/vikunjaa/status.svg)](https://drone.kolaente.de/vikunja/vikunja)
2020-12-23 16:41:52 +01:00
[![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](LICENSE)
[![Install](https://img.shields.io/badge/download-v0.24.2-brightgreen.svg)](https://vikunja.io/docs/installing)
[![Docker Pulls](https://img.shields.io/docker/pulls/vikunja/vikunja.svg)](https://hub.docker.com/r/vikunja/vikunja/)
2019-02-17 20:57:28 +01:00
[![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/kolaente.dev/vikunja/vikunja)](https://goreportcard.com/report/kolaente.dev/vikunja/vikunja)
2018-11-17 00:29:10 +01:00
2024-02-10 14:46:33 +01:00
# Vikunja
2019-02-17 19:53:04 +00:00
> The Todo-app to organize your life.
If Vikunja is useful to you, please consider [buying me a coffee](https://www.buymeacoffee.com/kolaente), [sponsoring me on GitHub](https://github.com/sponsors/kolaente) or buying [a sticker pack](https://vikunja.cloud/stickers).
I'm also offering [a hosted version of Vikunja](https://vikunja.cloud/) if you want a hassle-free solution for yourself or your team.
2019-02-17 19:53:04 +00:00
# Table of contents
2021-04-22 15:07:28 +02:00
* [Security Reports](#security-reports)
2019-02-17 19:53:04 +00:00
* [Features](#features)
* [Docs](#docs)
* [Roadmap](#roadmap)
* [Contributing](#contributing)
* [License](#license)
2021-04-22 15:07:28 +02:00
## Security Reports
If you find any security-related issues you don't want to disclose publicly, please use [the contact information on our website](https://vikunja.io/contact/#security).
2018-07-25 21:47:26 +02:00
## Features
See [the features page](https://vikunja.io/features/) on our website for a more exhaustive list or
2019-09-01 11:01:36 +02:00
try it on [try.vikunja.io](https://try.vikunja.io)!
2019-02-17 19:53:04 +00:00
## Docs
2019-02-17 20:57:28 +01:00
* [Installing](https://vikunja.io/docs/installing/)
* [Build from source](https://vikunja.io/docs/build-from-sources/)
* [Development setup](https://vikunja.io/docs/development/)
* [Magefile](https://vikunja.io/docs/magefile/)
2019-02-17 20:57:28 +01:00
* [Testing](https://vikunja.io/docs/testing/)
All docs can be found on [the Vikunja home page](https://vikunja.io/docs/).
2018-07-25 21:47:26 +02:00
### Roadmap
2021-01-10 16:09:26 +01:00
See [the roadmap](https://my.vikunja.cloud/share/QFyzYEmEYfSyQfTOmIRSwLUpkFjboaBqQCnaPmWd/auth) (hosted on Vikunja!) for more!
2018-12-25 21:29:16 +01:00
2019-02-17 19:53:04 +00:00
## Contributing
2018-07-25 21:47:26 +02:00
2024-02-10 14:46:33 +01:00
Please check out the contribuition guidelines on [the website](https://vikunja.io/docs/development/).
2018-07-25 21:47:26 +02:00
2019-02-17 19:53:04 +00:00
## License
2018-07-25 21:47:26 +02:00
2023-07-07 13:34:22 +02:00
This project is licensed under the AGPLv3 License. See the [LICENSE](LICENSE) file for the full license text.