Просмотр исходного кода

add darkwiki to the darkfi book & add README for both darkwiki and darkwikid

ghassmo 4 лет назад
Родитель
Сommit
507c431124
4 измененных файлов с 63 добавлено и 0 удалено
  1. 3 0
      bin/darkwiki/README.md
  2. 3 0
      bin/darkwikid/README.md
  3. 1 0
      doc/src/SUMMARY.md
  4. 56 0
      doc/src/misc/darkwiki.md

+ 3 - 0
bin/darkwiki/README.md

@@ -0,0 +1,3 @@
+# Tau
+
+see [Darkfi Book](https://darkrenaissance.github.io/darkfi/misc/darkwiki.html) for the installation guide.

+ 3 - 0
bin/darkwikid/README.md

@@ -0,0 +1,3 @@
+# Tau
+
+see [Darkfi Book](https://darkrenaissance.github.io/darkfi/misc/darkwiki.html) for the installation guide.

+ 1 - 0
doc/src/SUMMARY.md

@@ -23,6 +23,7 @@
   - [vanityaddr](misc/vanityaddr.md)
   - [ircd](misc/ircd.md)
   - [tau](misc/tau.md)
+  - [darkwiki](misc/darkwiki.md)
   - [dnetview](misc/dnetview.md)
 - [Learn](learn/learn.md)
   - [Research](learn/research.md)

+ 56 - 0
doc/src/misc/darkwiki.md

@@ -0,0 +1,56 @@
+rkwiki
+
+Collaborative wiki using peer-to-peer network and raft consensus.
+
+## Install
+
+```shell
+% git clone https://github.com/darkrenaissance/darkfi
+% cd darkfi
+% make BINS="darkwiki darkwikid"
+% sudo make install BINS="darkwikid darkwiki"
+```
+
+## Usage
+
+- Once Darkwiki get installed, darkwiki daemon must run in the background:
+
+```shell
+% darkwikid
+```
+
+1 - To update `synchronized directory` (default ~/darkwiki) and receive new documents from the network:
+
+```shell
+% darkwiki update
+```
+
+> **_NOTE:_**  The `synchronized directory` path can be changed from the config file in ~/.config/darkfi/darkwiki.toml
+
+2 - After add/edit a document in ~/darkwiki, the changes will be published by running
+  `update` command:
+
+```shell
+% darkwiki update
+```
+
+3 - For restore files having local changes to the original text: 
+
+```shell
+% darkwiki resotre
+```
+
+4 - For both `restore` and `update` commands, the flag `--dry-run` can show the changes without applying/publishing the patches
+
+```shell
+% darkwiki update --dry-run
+```
+
+5 - Both `restore` and `update` commands are accepting pass the files names instead of updating/restoring all the documents in ~/darkwiki
+
+```shell
+% darkwiki update file1.md file2.md 
+```
+
+
+