go/cid
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

Merge pull request #92 from b5/chore_remove_gx

Browse Source 
docs(readme): remove reference to gx
This commit is contained in:
Steven Allen
2019-12-09 06:47:25 -06:00
committed by GitHub
parent 9d598bbdbd c91a795815
commit e793e19f71
1 changed files with 2 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@@ -34,36 +34,16 @@ It is used in `go-ipfs` and related packages to refer to a typed hunk of data.
go get github.com/ipfs/go-cid
```
Note that `go-cid` is packaged with Gx, so it is recommended to use Gx to install and use it (see Usage section).
## Usage
### Using Gx and Gx-go
This module is packaged with [Gx](https://github.com/whyrusleeping/gx). In order to use it in your own project it is recommended that you:
```sh
go get -u github.com/whyrusleeping/gx
go get -u github.com/whyrusleeping/gx-go
cd <your-project-repository>
gx init
gx import github.com/ipfs/go-cid
gx install --global
gx-go --rewrite
```
Please check [Gx](https://github.com/whyrusleeping/gx) and [Gx-go](https://github.com/whyrusleeping/gx-go) documentation for more information.
### Running tests
Before running tests, please run:
Run tests with `go test` from the directory root
```sh
make deps
go test
```
This will make sure that dependencies are rewritten to known working versions.
### Examples
#### Parsing string input from users