komga/README.md

[![Open Collective backers and sponsors](https://img.shields.io/opencollective/all/komga?label=OpenCollective%20Sponsors&color=success)](https://opencollective.com/komga) ![GitHub Sponsors](https://img.shields.io/github/sponsors/gotson?label=Github%20Sponsors&color=success)
[![Discord](https://img.shields.io/discord/678794935368941569?label=Discord&color=blue)](https://discord.gg/TdRpkDu)

[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/gotson/komga/CI)](https://github.com/gotson/komga/actions?query=workflow%3ACI+branch%3Amaster)
[![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)

[![Translation status](https://hosted.weblate.org/widgets/komga/-/webui/svg-badge.svg)](https://hosted.weblate.org/engage/komga/)

# ![app icon](./.github/readme-images/app-icon.png) Komga

Komga is a free and open source comics/mangas server.

#### Chat on [Discord](https://discord.gg/TdRpkDu)

## Features

Features include:

- Browse libraries, series and books
- Search bar
- Download book files
- Manage multiple users, with per-library accesss control
- Webreader

## Download

Get the app from our [releases page](https://github.com/gotson/komga/releases) or through [Docker](https://hub.docker.com/r/gotson/komga).

## Documentation

Head over to our [website](https://komga.org) for more information.

## Develop in Komga

Check the [development guidelines](./DEVELOPING.md).

## Translation

[![Translation status](https://hosted.weblate.org/widgets/komga/-/webui/horizontal-auto.svg)](https://hosted.weblate.org/engage/komga/)

## Sponsors

| JetBrains |
|:---:|
| [![Jetbrains_logo](./.github/readme-images/sponsors-jetbrains.png)](https://www.jetbrains.com/?from=Komga) |

## Credits

The Komga icon is based on an icon made by [Freepik](https://www.freepik.com/home) from www.flaticon.com
docs: badges 2021-01-05 10:04:17 +08:00			`[![Open Collective backers and sponsors](https://img.shields.io/opencollective/all/komga?label=OpenCollective%20Sponsors&color=success)](https://opencollective.com/komga) ![GitHub Sponsors](https://img.shields.io/github/sponsors/gotson?label=Github%20Sponsors&color=success)`
			`[![Discord](https://img.shields.io/discord/678794935368941569?label=Discord&color=blue)](https://discord.gg/TdRpkDu)`
docs: add opencollective badge in README 2020-06-16 20:38:35 +08:00
docs: badges 2021-01-05 10:04:17 +08:00			`[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/gotson/komga/CI)](https://github.com/gotson/komga/actions?query=workflow%3ACI+branch%3Amaster)`
added badges 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)`

docs: add translation status in README.md 2021-02-22 14:03:58 +08:00			`[![Translation status](https://hosted.weblate.org/widgets/komga/-/webui/svg-badge.svg)](https://hosted.weblate.org/engage/komga/)`

added README 2019-08-21 15:51:00 +08:00			`# ![app icon](./.github/readme-images/app-icon.png) Komga`

Update README.md 2019-08-27 22:49:46 +08:00			`Komga is a free and open source comics/mangas server.`
added README 2019-08-21 15:51:00 +08:00
doc: update discord invite link 2020-02-20 09:22:32 +08:00			`#### Chat on [Discord](https://discord.gg/TdRpkDu)`
doc: add Discord info 2020-02-17 11:10:04 +08:00
added README 2019-08-21 15:51:00 +08:00			`## Features`

v0.5.0 2019-10-10 10:58:07 +08:00			`Features include:`
added README 2019-08-21 15:51:00 +08:00
docs: trim down README 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`
added README 2019-08-21 15:51:00 +08:00
docs: trim down README 2020-02-24 17:21:25 +08:00			`## Download`
Update README.md 2019-08-23 20:14:34 +08:00
docs: trim down README 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).`
Update README.md 2019-08-23 20:14:34 +08:00
docs: trim down README 2020-02-24 17:21:25 +08:00			`## Documentation`
Update README.md 2019-08-23 20:14:34 +08:00
docs: trim down README 2020-02-24 17:21:25 +08:00			`Head over to our [website](https://komga.org) for more information.`
better documentation on fat jar usage added sample configuration.yml for both Windows and Unix/Linux [ci skip] 2019-09-23 11:52:26 +08:00
docs: add development guidelines 2020-02-25 14:57:07 +08:00			`## Develop in Komga`

			`Check the [development guidelines](./DEVELOPING.md).`

docs: add translation status in README.md 2021-02-22 14:03:58 +08:00			`## Translation`

			`[![Translation status](https://hosted.weblate.org/widgets/komga/-/webui/horizontal-auto.svg)](https://hosted.weblate.org/engage/komga/)`

docs(readme): add sponsors section in README.md [ci skip] 2020-03-23 17:46:28 +08:00			`## Sponsors`

docs: remove mention of portable guide 2021-02-01 13:32:49 +08:00			`\| JetBrains \|`
			`\|:---:\|`
			`\| [![Jetbrains_logo](./.github/readme-images/sponsors-jetbrains.png)](https://www.jetbrains.com/?from=Komga) \|`
docs(readme): add sponsors section in README.md [ci skip] 2020-03-23 17:46:28 +08:00
added README 2019-08-21 15:51:00 +08:00			`## Credits`

add installation section 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`