Skip to content

Commit

Permalink
docs: update README (#174)
Browse files Browse the repository at this point in the history
  • Loading branch information
bgravenorst authored May 30, 2023
1 parent 17a3a99 commit 04365f7
Showing 1 changed file with 18 additions and 9 deletions.
27 changes: 18 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,26 @@
# Web3Signer documentation

Latest: [![Documentation Status](https://readthedocs.com/projects/pegasys-web3signer/badge/?version=latest)](https://docs.web3signer.consensys.net/en/latest/?badge=latest)
Stable: [![Documentation Status](https://readthedocs.com/projects/pegasys-web3signer/badge/?version=stable)](https://docs.web3signer.consensys.net/en/stable/?badge=stable)
[Web3Signer] is a transaction signing application to be used with a web3 provider. The software sources are hosted in the [Web3Signer] repository.

[Web3Signer] is a transaction signing application to be used with a web3 provider.
This documentation repo is built using [Docusaurus 2](https://docusaurus.io/).

The software sources are hosted in [Web3Signer] repository.
See [more](https://docs-template.consensys.net/) information about using Docusaurus quickly.

This repository only contains the sources for [Web3Signer documentation website hosted by ReadTheDocs.com].
### Contributing & Local Development

This repository uses a Git submodule. Please refer to the [common tools wiki] for explanation about
how to build and contribute to this documentation.
$ npm install
$ npm run prepare
$ npm start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

### Build

$ npm run build
$ npm run serve

This command generates static content into the `build` directory.

<!--- Links -->

[Web3Signer]: https://github.com/Consensys/web3signer
[common tools wiki]: https://github.com/Consensys/doc.common/wiki
[Web3Signer documentation website hosted by ReadTheDocs.com]: https://docs.web3signer.consensys.net/

1 comment on commit 04365f7

@vercel
Copy link

@vercel vercel bot commented on 04365f7 May 30, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.