depau/HackMD
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

more ways to engage with the community added to the readme

Browse source 
Signed-off-by: Claudius <opensource@amenthes.de>
This commit is contained in:
Claudius 2019-04-03 23:09:36 +02:00 committed by Claudius Coenen
parent 07a0594c9a
commit acd7634fc7
1 changed files with 20 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
README.md
View file

@ -6,25 +6,28 @@ CodiMD
[![version][github-version-badge]][github-release-page] [![version][github-version-badge]][github-release-page]
[![POEditor][poeditor-image]][poeditor-url] [![POEditor][poeditor-image]][poeditor-url]
CodiMD lets you create real-time collaborative markdown notes. CodiMD lets you create real-time collaborative markdown notes. You can test-drive
it by visiting our [CodiMD demo server][codimd-demo].
It is inspired by Hackpad, Etherpad and similar collaborative editors. This It is inspired by Hackpad, Etherpad and similar collaborative editors. This
project originated with the team at [HackMD](https://hackmd.io) and now forked project originated with the team at [HackMD](https://hackmd.io) and now forked
into its own organisation. [A longer writeup can be read in the history doc](docs/history.md). into its own organisation. [A longer writeup can be read in the history doc](docs/history.md).
![CodiMD 1.3.2 with its feature demonstration page open](docs/images/CodiMD-1.3.2-features.png) [![CodiMD 1.3.2 with its feature demonstration page open](docs/images/CodiMD-1.3.2-features.png)][codimd-demo-features]
## Community and Contributions ## Community and Contributions
We welcome contributions! There's a lot to do. If you would like to report bugs, We welcome contributions! There's a lot to do: If you would like to report bugs,
the [issue tracker](github-issue-tracker) is the right place. If you want to the [issue tracker][github-issue-tracker] is the right place. If you can help
help translating, find us on [POEditor](poeditor-url). To get started developing, translating, find us on [POEditor][poeditor-url]. To get started developing,
take a look at the [docs/dev](docs/dev) directory. In any case: come talk to us, take a look at the [docs/dev](docs/dev) directory. In any case: come talk to us,
we'll be delighted to help you with the first steps. we'll be delighted to help you with the first steps.
To stay up to date with our work it's recommended to join our To stay up to date with our work or get support it's recommended to join our
[Matrix channel][matrix.org-url] or subscribe to the [release feed][github-release-feed]. [Matrix channel][matrix.org-url], stop by our [community forums][codimd-community]
or subscribe to the [release feed][github-release-feed]. We also engage in
regular [community calls][codimd-community-calls] which you are very welcome to join.
## Installation / Upgrading ## Installation / Upgrading
@ -71,6 +74,12 @@ To use CodiMD, your browser should match or exceed these versions:
- Android Browser >= 4.4 - Android Browser >= 4.4
## Related Tools
Our community has created related tools, we'd like to highlight [codimd-cli](https://github.com/codimd/cli)
which lets you use CodiMD from the comfort of your command line.
# License # License
Licensed under AGPLv3. For our list of contributors, see [AUTHORS](AUTHORS). Licensed under AGPLv3. For our list of contributors, see [AUTHORS](AUTHORS).
@ -85,3 +94,7 @@ Licensed under AGPLv3. For our list of contributors, see [AUTHORS](AUTHORS).
[github-issue-tracker]: https://github.com/codimd/server/issues/ [github-issue-tracker]: https://github.com/codimd/server/issues/
[poeditor-image]: https://img.shields.io/badge/POEditor-translate-blue.svg [poeditor-image]: https://img.shields.io/badge/POEditor-translate-blue.svg
[poeditor-url]: https://poeditor.com/join/project/1OpGjF2Jir [poeditor-url]: https://poeditor.com/join/project/1OpGjF2Jir
[codimd-demo]: https://demo.codimd.org
[codimd-demo-features]: https://demo.codimd.org/features
[codimd-community]: https://community.codimd.org
[codimd-community-calls]: https://github.com/codimd/server/issues/16