Skip to content

Commit

Permalink
docs: update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
chevdor committed Jul 6, 2021
1 parent 9897ddc commit 27376a1
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

## Introduction

[srtool](https://gitlab.com/chevdor/srtool) is a docker image that allows building Substrate WASM Runtimes in a deterministic manner. It ensures that all `srtool` users (and tooling), using the same/latest tag, will produce 100% exactly the same runtime. It enables further trustless verifications.
[srtool](https://github.com/chevdor/srtool) is a docker image that allows building Substrate WASM Runtimes in a deterministic manner. It ensures that all `srtool` users (and tooling), using the same/latest tag, will produce 100% exactly the same runtime. It enables further trustless verifications.

![srtool gh action 512px](resources/logo/srtool-gh-action_512px.png)

Expand All @@ -29,11 +29,11 @@ Gitlab users are not left behind and can use the 2 first options mentioned below

There are now several ways to use `srtool` in your project:

- using `srtool` [via alias](https://gitlab.com/chevdor/srtool#user-content-using-an-alias): powerful but very verbose and prone to errors. This is for developers. This option is being deprecated and not recommended.
- using `srtool` [via alias](https://github.com/chevdor/srtool#user-content-using-an-alias): powerful but very verbose and prone to errors. This is for developers. This option is being deprecated and not recommended.

- using the [srtool-cli](https://gitlab.com/chevdor/srtool-cli): much easier to use and removes a whole bunch of potential user’s mistakes. This is for developers.
- using the [srtool-cli](https://github.com/chevdor/srtool-cli): much easier to use and removes a whole bunch of potential user’s mistakes. This is for developers.

- using the [srtool-app](https://gitlab.com/chevdor/srtool-app): the easiest option of all thanks to its GUI. This is good for non-developers.
- using the [srtool-app](https://github.com/chevdor/srtool-app): the easiest option of all thanks to its GUI. This is good for non-developers.

- using the Github actions from [this repo](https://github.com/chevdor/srtool-actions). This is for your automatic CI.

Expand Down
8 changes: 4 additions & 4 deletions README_src.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ a| image::https://github.com/chevdor/srtool-actions/actions/workflows/polkadot.y

== Introduction

https://gitlab.com/chevdor/srtool[srtool] is a docker image that allows building Substrate WASM Runtimes in a deterministic manner. It ensures that all `srtool` users (and tooling), using the same/latest tag, will produce 100% exactly the same runtime. It enables further trustless verifications.
https://github.com/chevdor/srtool[srtool] is a docker image that allows building Substrate WASM Runtimes in a deterministic manner. It ensures that all `srtool` users (and tooling), using the same/latest tag, will produce 100% exactly the same runtime. It enables further trustless verifications.

image::resources/logo/srtool-gh-action_512px.png[align=center, width=25%]

Expand All @@ -25,9 +25,9 @@ NOTE: Gitlab users are not left behind and can use the 2 first options mentioned

There are now several ways to use `srtool` in your project:

- using `srtool` https://gitlab.com/chevdor/srtool#user-content-using-an-alias[via alias]: powerful but very verbose and prone to errors. This is for developers. This option is being deprecated and not recommended.
- using the https://gitlab.com/chevdor/srtool-cli[srtool-cli]: much easier to use and removes a whole bunch of potential user's mistakes. This is for developers.
- using the https://gitlab.com/chevdor/srtool-app[srtool-app]: the easiest option of all thanks to its GUI. This is good for non-developers.
- using `srtool` https://github.com/chevdor/srtool#user-content-using-an-alias[via alias]: powerful but very verbose and prone to errors. This is for developers. This option is being deprecated and not recommended.
- using the https://github.com/chevdor/srtool-cli[srtool-cli]: much easier to use and removes a whole bunch of potential user's mistakes. This is for developers.
- using the https://github.com/chevdor/srtool-app[srtool-app]: the easiest option of all thanks to its GUI. This is good for non-developers.
- using the Github actions from https://github.com/chevdor/srtool-actions[this repo]. This is for your automatic CI.

== Requirements
Expand Down

0 comments on commit 27376a1

Please sign in to comment.