komga/README.md

37 lines
1.2 KiB
Markdown
Raw Normal View History

2019-09-06 11:04:39 +08:00
[![Build Status](https://travis-ci.com/gotson/komga.svg?branch=master)](https://travis-ci.com/gotson/komga)
2019-09-02 17:46:27 +08:00
[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/gotson/komga?color=blue&label=download&sort=semver)](https://github.com/gotson/komga/releases)
[![Docker Pulls](https://img.shields.io/docker/pulls/gotson/komga)](https://hub.docker.com/r/gotson/komga)
2020-02-20 09:22:32 +08:00
[![Discord](https://img.shields.io/discord/678794935368941569?label=Discord)](https://discord.gg/TdRpkDu)
2019-09-02 17:46:27 +08:00
2019-08-21 15:51:00 +08:00
# ![app icon](./.github/readme-images/app-icon.png) Komga
2019-08-27 22:49:46 +08:00
Komga is a free and open source comics/mangas server.
2019-08-21 15:51:00 +08:00
2020-02-20 09:22:32 +08:00
#### Chat on [Discord](https://discord.gg/TdRpkDu)
2020-02-17 11:10:04 +08:00
2019-08-21 15:51:00 +08:00
## Features
2019-10-10 10:58:07 +08:00
Features include:
2019-08-21 15:51:00 +08:00
2020-02-24 17:21:25 +08:00
- Browse libraries, series and books
- Search bar
- Download book files
- Manage multiple users, with per-library accesss control
- Webreader
2019-08-21 15:51:00 +08:00
2020-02-24 17:21:25 +08:00
## Download
2019-08-23 20:14:34 +08:00
2020-02-24 17:21:25 +08:00
Get the app from our [releases page](https://github.com/gotson/komga/releases) or through [Docker](https://hub.docker.com/r/gotson/komga).
2019-08-23 20:14:34 +08:00
2020-02-24 17:21:25 +08:00
## Documentation
2019-08-23 20:14:34 +08:00
2020-02-24 17:21:25 +08:00
Head over to our [website](https://komga.org) for more information.
2020-02-25 14:57:07 +08:00
## Develop in Komga
Check the [development guidelines](./DEVELOPING.md).
2019-08-21 15:51:00 +08:00
## Credits
2019-08-22 08:43:30 +08:00
The Komga icon is based on an icon made by [Freepik](https://www.freepik.com/home) from www.flaticon.com