1<div align="center">
2
3<img width="64px" src="https://cdn.rawgit.com/git-bug/git-bug/master/misc/logo/logo-alpha-flat-bg.svg">
4
5# git-bug: a decentralized issue tracker
6
7[![Build Status][ci/badge]][ci/url]
8
9[![Backers on Open Collective][backers/badge]][oc]
10[![Sponsors on Open Collective][sponsors/badge]][oc]
11[![GPL v3 License][license/badge]][license/url]
12[![GoDoc][godoc/badge]][godoc/url]
13[![Go Report Card][report-card/badge]][report-card/url]
14[![Matrix][matrix/badge]][matrix/url]
15
16[Issues] - [Documentation][doc] - [Feedback][discuss]
17
18</div>
19
20## Overview<a name="overview"></a>
21
22[git-bug](https://github.com/git-bug/git-bug) is a standalone, distributed,
23offline-first issue management tool that embeds issues, comments, and more as
24objects in a git repository (_not files!_), enabling you to push and pull them
25to one or more remotes.
26
27<!-- mdformat-toc start --slug=github --maxlevel=6 --minlevel=2 -->
28
29- [Overview](#overview)
30- [Key Features](#key-features)
31- [Getting Started](#getting-started)
32- [Our Community](#our-community)
33 - [Backers :star:](#backers-star)
34 - [Sponsors :star2:](#sponsors-star2)
35- [License](#license)
36
37<!-- mdformat-toc end -->
38
39## Key Features<a name="key-features"></a>
40
41- **Native Git Storage:** Manage issues, users, and comments directly within
42 your repository - keeping everything versioned and clutter-free
43- **Distributed & Versioned:** Leverage Git’s decentralized architecture to work
44 offline and sync seamlessly later
45- **Lightning Fast:** List and search issues in mere _milliseconds_
46- **Third-Party Bridges:** Easily synchronize issues with platforms like GitHub
47 and GitLab [using bridges][doc/usage/bridges]
48- **Flexible Interfaces:** Choose how you interact - via CLI, TUI, or a web
49 browser
50- **Effortless Integration:** Start managing issues your repository with minimal
51 setup
52
53## Getting Started<a name="getting-started"></a>
54
55- :triangular_flag_on_post: **Install:** Check out
56 [`//:INSTALLATION.md`][doc/install] for step-by-step installation instructions
57 or explore [the latest release][rel/latest] to get started immediately.
58- :page_with_curl: **Explore:** Read [the documentation][doc] to learn how to
59 use `git-bug` effectively
60- :computer: **Contribute:** Interested in hacking on `git-bug`? Head over to
61 [`//:CONTRIBUTING.md`][contrib] and see how you can help shape the project
62- :speech_balloon: **Connect:** Chat with us live on Matrix at
63 [`#git-bug:matrix.org`][matrix/url]
64- :books: **Discuss:** Browse [existing discussions][discuss] or
65 [start a new one][discuss/new] to ask questions and share ideas
66
67## Our Community<a name="our-community"></a>
68
69`git-bug` thrives thanks to the passion of its [contributors], the generosity of
70independent [backers][oc], and the strategic support of our [sponsors][oc]. Each
71of you plays a crucial role in our journey, and we deeply appreciate every
72contribution that helps drive our project forward.
73
74_[Make a contribution][oc] to support this project and get featured below!_
75
76### Backers :star:<a name="backers-star"></a>
77
78<div align="center">
79
80[![backers][backers/image]][oc]
81
82</div>
83
84### Sponsors :star2:<a name="sponsors-star2"></a>
85
86<div align="center">
87
88[![][sponsor/0]][sponsor/0/url]
89
90</div>
91
92## License<a name="license"></a>
93
94Unless otherwise stated, this project and all assets within it are released
95under [GPLv3][license/url] or later, copyright [Michael Muré][gh/mm].
96
97The `git-bug` logo is authored by and copyright [Viktor Teplov][gh/vandesign],
98released under a [CC BY 4.0][license/logo] license.
99
100______________________________________________________________________
101
102<div align="center">
103
104This project and its vibrant community was initially dreamt up and built by
105[Michael Muré][gh/mm].
106
107Thank you for all of your hard work!
108
109:heart:
110
111</div>
112
113[backers/badge]: https://opencollective.com/git-bug/backers/badge.svg
114[backers/image]: https://opencollective.com/git-bug/tiers/backer.svg?avatarHeight=50
115[ci/badge]: https://github.com/git-bug/git-bug/actions/workflows/trunk.yml/badge.svg
116[ci/url]: https://github.com/git-bug/git-bug/actions/workflows/trunk.yml
117[contrib]: ./CONTRIBUTING.md
118[contributors]: https://github.com/git-bug/git-bug/graphs/contributors
119[discuss]: https://github.com/git-bug/git-bug/discussions
120[discuss/new]: https://github.com/git-bug/git-bug/discussions/new/choose
121[doc]: ./doc
122[doc/install]: ./INSTALLATION.md
123[doc/usage/bridges]: ./doc/usage/third-party.md
124[gh/mm]: https://github.com/MichaelMure
125[gh/vandesign]: https://github.com/vandesign
126[godoc/badge]: https://godoc.org/github.com/git-bug/git-bug?status.svg
127[godoc/url]: https://godoc.org/github.com/git-bug/git-bug
128[issues]: https://github.com/git-bug/git-bug/issues
129[license/badge]: https://img.shields.io/badge/License-GPLv3+-blue.svg
130[license/logo]: ./misc/logo/LICENSE
131[license/url]: ./LICENSE
132[matrix/badge]: https://img.shields.io/badge/chat%20on%20matrix-%23238636
133[matrix/url]: https://matrix.to/#/#git-bug:matrix.org
134[oc]: https://opencollective.com/git-bug
135[rel/latest]: https://github.com/git-bug/git-bug/releases/latest
136[report-card/badge]: https://goreportcard.com/badge/github.com/git-bug/git-bug
137[report-card/url]: https://goreportcard.com/report/github.com/git-bug/git-bug
138[sponsor/0]: https://opencollective.com/git-bug/tiers/sponsor/0/avatar.svg
139[sponsor/0/url]: https://opencollective.com/git-bug/sponsor/0/website
140[sponsors/badge]: https://opencollective.com/git-bug/sponsors/badge.svg