Skip to content

Commit 6173300

Browse files
authored
Update README.md
1 parent 57672a6 commit 6173300

File tree

1 file changed

+3
-8
lines changed

1 file changed

+3
-8
lines changed

README.md

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,26 +22,21 @@ CodiMD is perfect for open communities, while HackMD emphasizes on permission an
2222
HackMD team is committed to keep CodiMD open source. All contributions are welcome!
2323

2424
## Documentation
25-
You can find all documentation here: [CodiMD Documentation](https://hackmd.io/c/codimd-documentation)
25+
You would find all documentation here: [CodiMD Documentation](https://hackmd.io/c/codimd-documentation)
2626

2727
### Deployment
2828
If you want to spin up an instance and start using immediately, see [Docker deployment](https://hackmd.io/c/codimd-documentation/%2Fs%2Fcodimd-documentation#Deployment).
2929
If you want to contribute to the project, start with [manual deployment](https://hackmd.io/c/codimd-documentation/%2Fs%2Fcodimd-manual-deployment).
3030

3131
### Configuration
32-
You can configure CodiMD either with the [config file](https://hackmd.io/c/codimd-documentation/%2Fs%2Fcodimd-config-json-file) `.config.json` or with
33-
[environment variables](https://hackmd.io/c/codimd-documentation/%2Fs%2Fcodimd-config-environment-variable).
34-
35-
Environment variables overwrites `config.json`, see the detailed config precedence here: [`.lib/config/index.js#37`](https://github.com/hackmdio/codimd/blob/develop/lib/config/index.js#L37).
32+
CodiMD is highly customizable, learn about all configuration options of networking, security, performance, resources, privilege, privacy, image storage, and authentication in [CodiMD Configuration](/s/codimd-configuration).
3633

3734
### Upgrading and Migration
3835
Upgrade CodiMD from previous version? See [this guide](https://hackmd.io/c/codimd-documentation/%2Fs%2Fcodimd-upgrade)
39-
4036
Migrating from Etherpad? Follow [this guide](https://hackmd.io/c/codimd-documentation/%2Fs%2Fcodimd-migration-etherpad)
4137

4238
### Developer
43-
Start developing with [manual deployment](https://hackmd.io/c/codimd-documentation/%2Fs%2Fcodimd-manual-deployment).
44-
39+
Join our contributor community! Start from deploying CodiMD manually, connecting to your own database, learn about the project structure, and build your changes with the help of webpack.
4540

4641
## Contribution and Discussion
4742
All contributions are welcome! Even asking a question helps.

0 commit comments

Comments
 (0)