Skip to content
Snippets Groups Projects
Commit fa559ea3 authored by Éloïs's avatar Éloïs
Browse files

[docs] update README (+ apply markdown linter)

parent 0502d2c4
No related branches found
No related tags found
No related merge requests found
...@@ -9,63 +9,80 @@ Inspired by [Bitcoin](https://github.com/bitcoin/bitcoin) and [OpenUDC](https:// ...@@ -9,63 +9,80 @@ Inspired by [Bitcoin](https://github.com/bitcoin/bitcoin) and [OpenUDC](https://
<p align="center"><img src="https://git.duniter.org/nodes/typescript/duniter/raw/dev/images/duniter_admin_g1.png" /></p> <p align="center"><img src="https://git.duniter.org/nodes/typescript/duniter/raw/dev/images/duniter_admin_g1.png" /></p>
## Development state ## Development state
[Ğ1, first libre currency for production using Duniter have been launched March 8th 2017](https://en.duniter.org/g1-go/). [Ğ1, first libre currency for production using Duniter have been launched March 8th 2017](https://en.duniter.org/g1-go/).
However, we are running simultaneously a testing currency. However, we are running simultaneously a testing currency.
### Add your node to the network ### Add your node to the network
See [Install a node documentation](https://duniter.org/en/wiki/duniter/install/). See [Install a node documentation](https://duniter.org/en/wiki/duniter/install/).
### Clients, wallets ### Clients, wallets
#### Cesium #### Cesium
- [Website](https://cesium.app/) - [Website](https://cesium.app/)
- [Repository](https://git.duniter.org/clients/cesium-grp/cesium) - [Repository](https://git.duniter.org/clients/cesium-grp/cesium)
#### Sakia #### Sakia
- [Website](http://sakia-wallet.org) - [Website](http://sakia-wallet.org)
- [Repository](https://git.duniter.org/clients/python/sakia) - [Repository](https://git.duniter.org/clients/python/sakia)
#### Silkaj #### Silkaj
- [Website](https://silkaj.duniter.org) - [Website](https://silkaj.duniter.org)
- [Repository](https://git.duniter.org/clients/python/silkaj) - [Repository](https://git.duniter.org/clients/python/silkaj)
## Going further ## Going further
### Contribute ### Contribute
- [Quick-start-guide : start a duniter node with web-ui from source](https://git.duniter.org/nodes/typescript/duniter/blob/dev/doc/quick-start.md) - [Quick-start-guide : start a duniter node with web-ui from source](https://git.duniter.org/nodes/typescript/duniter/blob/dev/doc/quick-start.md)
- [Guide (fr)](https://git.duniter.org/nodes/typescript/duniter/blob/dev/doc/contribute-french.md) - [Guide (fr)](https://git.duniter.org/nodes/typescript/duniter/blob/dev/doc/contribute-french.md)
- [Developer guide](https://git.duniter.org/nodes/typescript/duniter/blob/dev/doc/developer-guide.md) - [Developer guide](https://git.duniter.org/nodes/typescript/duniter/blob/dev/doc/developer-guide.md)
### Documentation ### Documentation
Visit [Duniter website](https://duniter.org): it gathers theoretical informations, FAQ and several useful links. If you want to learn, this is the first place to visit. Visit [Duniter website](https://duniter.org): it gathers theoretical informations, FAQ and several useful links. If you want to learn, this is the first place to visit.
### Talk about/get involved in Duniter project ### Talk about/get involved in Duniter project
If you wish to participate/debate on Duniter, you can: If you wish to participate/debate on Duniter, you can:
* visit [Duniter Forum](https://forum.duniter.org) - visit [Duniter Forum](https://forum.duniter.org)
* join [XMPP chatroom](https://chat.duniter.org) [xmpp://duniter@muc.duniter.org](xmpp://duniter@muc.duniter.org) - join [XMPP chatroom](https://chat.duniter.org) [xmpp://duniter@muc.duniter.org](xmpp://duniter@muc.duniter.org)
* contact us directly at [contact@duniter.org](mailto:contact@duniter.org) - contact us directly at [contact@duniter.org](mailto:contact@duniter.org)
* subscribe to [a mailing list for Duniter node's administrators](https://listes.aquilenet.fr/sympa/subscribe/duniter-node-admins) - subscribe to [a mailing list for Duniter node's administrators](https://listes.aquilenet.fr/sympa/subscribe/duniter-node-admins)
### Developement ### Developement
Duniter is using modules on different git repositories: Duniter is using modules on different git repositories:
- [WotB](https://github.com/duniter/wotb): compute Web of Trust.
- [WotB](https://git.duniter.org/libs/dubp-wot): compute Web of Trust.
- [Debug](https://github.com/duniter/duniter-debug): debug tool. - [Debug](https://github.com/duniter/duniter-debug): debug tool.
- [Web admin](https://git.duniter.org/nodes/typescript/modules/duniter-ui): web administration interface (optional). - [Web admin](https://git.duniter.org/nodes/typescript/modules/duniter-ui): web administration interface (optional).
- [GVA](https://git.duniter.org/nodes/typescript/modules/gva-api): Future client API aimed to replace BMA. GVA stands for GraphQL Validation API. - [GVA](https://git.duniter.org/nodes/typescript/modules/gva-api): Future client API aimed to replace BMA. GVA stands for GraphQL Validation API.
Optional modules: Optional modules:
- [Currency monit](https://git.duniter.org/nodes/typescript/modules/duniter-currency-monit): charts to monitor currency and web of trust state. - [Currency monit](https://git.duniter.org/nodes/typescript/modules/duniter-currency-monit): charts to monitor currency and web of trust state.
- [Remuniter](https://github.com/duniter/remuniter): service to remunerate blocks issuers. - [Remuniter](https://github.com/duniter/remuniter): service to remunerate blocks issuers.
- [Wot explorer](https://github.com/c-geek/wotex): Web of Trust explorer. - [Wot explorer](https://github.com/c-geek/wotex): Web of Trust explorer.
# References # References
## Theoretical ## Theoretical
* [(en) Relative theory of money](http://en.trm.creationmonetaire.info)
* [(fr) Théorie relative de la monnaie](http://trm.creationmonetaire.info) - [(en) Relative theory of money](http://en.trm.creationmonetaire.info)
- [(fr) Théorie relative de la monnaie](http://trm.creationmonetaire.info)
## OpenUDC ## OpenUDC
* [OpenUDC repository](https://github.com/Open-UDC/open-udc)
* [Other project trying to implement OpenUDC in python](https://github.com/canercandan/django-openudc) - [OpenUDC repository](https://github.com/Open-UDC/open-udc)
- [Other project trying to implement OpenUDC in python](https://github.com/canercandan/django-openudc)
# License # License
This software is distributed under [GNU AGPLv3](https://git.duniter.org/nodes/typescript/duniter/blob/dev/LICENSE). This software is distributed under [GNU AGPLv3](https://git.duniter.org/nodes/typescript/duniter/blob/dev/LICENSE).
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment