Skip to content
This repository has been archived by the owner on May 27, 2020. It is now read-only.

Commit

Permalink
Add usage guide
Browse files Browse the repository at this point in the history
  • Loading branch information
hleb-albau committed Feb 17, 2019
1 parent 09090c7 commit db7fef0
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 7 deletions.
6 changes: 1 addition & 5 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ jobs:
workflows:
version: 2
cyberd_build:
default_workflow:
jobs:
- build_and_test:
filters:
Expand All @@ -75,10 +75,6 @@ workflows:
<<: *master_filter
requires:
- build_and_test
- update_docs:
<<: *master_filter
requires:
- build_and_test
- release_binaries:
<<: *release_filter
requires:
Expand Down
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ initial_guess_impact_results
*.so
*.o

cyberdcli
cyber-wiki
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,29 @@

## Usage

### Submit links
Basically, there are two main functions provided by `cyber-wiki` tool.
The first one is to parse wiki titles and submit links between keywords and wiki pages.
```
submit-links-to-cyber enwiki-latest-all-titles --offset=0 --address=007
submit-links-to-cyber /home/user/enwiki-latest-all-titles --address=cli_acc_y0y
```

Here, **enwiki-latest-all-titles** is titles file obtained from
[official Wiki dumps](https://dumps.wikimedia.org/enwiki/latest/enwiki-latest-all-titles-in-ns0.gz).

> Note: Uses only local cyber node.
> Note: Submit links do not add duras to ipfs.
### Uploading duras to IPFS
Also, `cyber-wiki` has separate command `upload-duras-to-ipfs` to upload files to local IPFS.
All duras are collected under single root unixfs directory.
```
upload-duras-to-ipfs /home/user/enwiki-latest-all-titles
```
> Note: We already upload duras.
They can be downloaded and pined on yor local node by **Qmdwsryu8HskLzBspzPwJbL8UZ1ZPZF8VemtW1ja1GMXGp** hash.

## Issues

If you have any problems with or questions about search, please contact us through a
Expand Down

0 comments on commit db7fef0

Please # to comment.