summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md59
1 files changed, 29 insertions, 30 deletions
diff --git a/README.md b/README.md
index 80060e2b..6081a02e 100644
--- a/README.md
+++ b/README.md
@@ -1,21 +1,20 @@
-# CodiMD
+![HedgeDoc Logo](https://raw.githubusercontent.com/hedgedoc/hedgedoc-logo/main/LOGOTYPE/SVG/HedgeDoc-Logo%204b.svg)
-[![#CodiMD on matrix.org][matrix.org-image]][matrix.org-url]
-[![build status][travis-image]][travis-url]
+# HedgeDoc
+
+[![#HedgeDoc on matrix.org][matrix.org-image]][matrix.org-url]
[![version][github-version-badge]][github-release-page]
[![POEditor][poeditor-image]][poeditor-url]
[![Mastodon][social-mastodon-image]][social-mastodon]
-CodiMD lets you create real-time collaborative markdown notes. You can test-drive
-it by visiting our [CodiMD demo server][codimd-demo].
-
-**Note**: CodiMD is in the process of [changing its name to HedgeDoc](https://github.com/codimd/server/issues/452).
+HedgeDoc lets you create real-time collaborative markdown notes. You can test-drive
+it by visiting our [HedgeDoc demo server][hedgedoc-demo].
It is inspired by Hackpad, Etherpad and similar collaborative editors. This
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).
-[![CodiMD 1.3.2 with its feature demonstration page open](docs/images/CodiMD-1.3.2-features.png)][codimd-demo-features]
+[![HedgeDoc 1.3.2 with its feature demonstration page open](docs/images/CodiMD-1.3.2-features.png)][hedgedoc-demo-features]
## Community and Contributions
@@ -26,13 +25,13 @@ 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.
To stay up to date with our work or get support it's recommended to join our
-[Matrix channel][matrix.org-url], stop by our [community forums][codimd-community]
+[Matrix channel][matrix.org-url], stop by our [community forums][hedgedoc-community]
or subscribe to the [release feed][github-release-feed]. We also engage in
-regular [community calls][codimd-community-calls] ([RSS](https://community.codimd.org/t/codimd-community-call/19.rss)) which you are very welcome to join.
+regular [community calls][hedgedoc-community-calls] ([RSS](https://community.hedgedoc.org/t/codimd-community-call/19.rss)) which you are very welcome to join.
## Installation / Upgrading
-You can run CodiMD in a number of ways, and we created setup instructions for
+You can run HedgeDoc in a number of ways, and we created setup instructions for
all of these:
- [Docker](docs/setup/docker.md)
@@ -44,10 +43,10 @@ all of these:
## Configuration
-Theres two main ways to [configure](docs/configuration.md) your CodiMD instance:
+Theres two main ways to [configure](docs/configuration.md) your HedgeDoc instance:
config file or environment variables. You can choose what works best for you.
-CodiMD can integrate with
+HedgeDoc can integrate with
- facebook, twitter, github, gitlab, mattermost, dropbox, google, ldap, saml and [oauth2](docs/guides/auth/oauth.md) **for login**
- imgur, s3, minio, azure **for image/attachment storage** (files can also be local!)
@@ -57,7 +56,7 @@ More info about that can be found in the configuration docs above.
## Browser support
-To use CodiMD, your browser should match or exceed these versions:
+To use HedgeDoc, your browser should match or exceed these versions:
- ![Chrome](https://raw.githubusercontent.com/alrra/browser-logos/HEAD/src/chrome/chrome_24x24.png) Chrome >= 47, ![Chrome](https://raw.githubusercontent.com/alrra/browser-logos/HEAD/src/chrome/chrome_24x24.png) Chrome for Android >= 47
- ![Safari](https://raw.githubusercontent.com/alrra/browser-logos/HEAD/src/safari/safari_24x24.png) Safari >= 9, ![iOS Safarai](https://raw.githubusercontent.com/alrra/browser-logos/HEAD/src/safari-ios/safari-ios_24x24.png) iOS Safari >= 8.4
@@ -68,36 +67,36 @@ To use CodiMD, your browser should match or exceed these versions:
## Backup/restore your instance
-To backup codimd, you should:
+To backup HedgeDoc, you should:
- backup your database
- backup your custom config file if you have one
-- backup the upload folder (see the [uploadsPath](./docs/configuration.md#codimd-paths-stuff) config directive)
+- backup the upload folder (see the [uploadsPath](./docs/configuration.md#hedgedoc-paths-stuff) config directive)
-Restoring an existing instance of codimd is then just a matter of restoring these elements.
+Restoring an existing instance of HedgeDoc is then just a matter of restoring these elements.
## 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.
+Our community has created related tools, we'd like to highlight [hedgedoc-cli](https://github.com/hedgedoc/cli)
+which lets you use HedgeDoc from the comfort of your command line.
## License
Licensed under AGPLv3. For our list of contributors, see [AUTHORS](AUTHORS).
+The license does not include the HedgeDoc logo, whose terms of usage can be found in the [github repository](https://github.com/hedgedoc/hedgedoc-logo).
+
[matrix.org-image]: https://img.shields.io/matrix/hedgedoc:matrix.org?logo=matrix&server_fqdn=matrix.org
[matrix.org-url]: https://matrix.to/#/#hedgedoc:matrix.org
-[travis-image]: https://travis-ci.org/codimd/server.svg?branch=master
-[travis-url]: https://travis-ci.org/codimd/server
-[github-version-badge]: https://img.shields.io/github/release/codimd/server.svg
-[github-release-page]: https://github.com/codimd/server/releases
-[github-release-feed]: https://github.com/codimd/server/releases.atom
-[github-issue-tracker]: https://github.com/codimd/server/issues/
+[github-version-badge]: https://img.shields.io/github/release/hedgedoc/hedgedoc.svg
+[github-release-page]: https://github.com/hedgedoc/hedgedoc/releases
+[github-release-feed]: https://github.com/hedgedoc/hedgedoc/releases.atom
+[github-issue-tracker]: https://github.com/hedgedoc/hedgedoc/issues/
[poeditor-image]: https://img.shields.io/badge/POEditor-translate-blue.svg
[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://community.codimd.org/t/codimd-community-call/19
-[social-mastodon]: https://social.codimd.org/mastodon
+[hedgedoc-demo]: https://demo.hedgedoc.org
+[hedgedoc-demo-features]: https://demo.hedgedoc.org/features
+[hedgedoc-community]: https://community.hedgedoc.org
+[hedgedoc-community-calls]: https://community.hedgedoc.org/t/codimd-community-call/19
+[social-mastodon]: https://social.hedgedoc.org/mastodon
[social-mastodon-image]: https://img.shields.io/mastodon/follow/18547?domain=https%3A%2F%2Fsocial.snopyta.org&style=social