Skip to content

Commit 5438bc0

Browse files
cooperkabochaco
authored andcommitted
Minor README improvements (#151)
* Polish the tagline * Remove extra characters for easier copy-paste * Clean up various wording * Make Prerequisites step 1 * Add links to further help resources
1 parent 904203b commit 5438bc0

1 file changed

Lines changed: 28 additions & 24 deletions

File tree

README.md

Lines changed: 28 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,63 @@
11
# safe_browser
22

3-
> SAFE Browser is a browser designed to open safe:// websites on the SAFE Network.
3+
A browser designed to open `safe://` websites on the SAFE Network.
44

55
**Maintainer:** Krishna Kumar (krishna.kumar@maidsafe.net)
66

77
## Development
88

9-
### Prerequisites
9+
1. Prerequisites:
1010

11-
* Node.js 6.5.0 (we recommend installing it via [nvm](https://github.com/creationix/nvm))
12-
* [Git](https://git-scm.com/)
13-
* [Yarn](https://yarnpkg.com) (as a replacement for `npm`).
11+
* Node.js 6.5.0 (we recommend installing it via [nvm](https://github.com/creationix/nvm))
12+
* [Git](https://git-scm.com/)
13+
* [Yarn](https://yarnpkg.com) (as a replacement for `npm`).
1414

15-
16-
1. Clone this GitHub repository.
15+
2. Clone this GitHub repository:
1716

1817
```bash
19-
$ git clone https://github.com/maidsafe/safe_browser.git
18+
git clone https://github.com/maidsafe/safe_browser.git
2019
```
2120

22-
2. Install the dependencies.
21+
3. Install the dependencies:
2322

2423
``` bash
25-
$ cd safe_browser
26-
$ yarn
24+
cd safe_browser
25+
yarn
2726
```
2827

29-
If you are working on a development environment, you can run `NODE_ENV=dev yarn` instead in order to get the `safe_client` libraries which use the `MockVault` file rather than connecting to the SAFE Network.
28+
If you're actively developing, you can run `NODE_ENV=dev yarn` instead in order to get the `safe_client` libraries which use the `MockVault` file rather than connecting to the SAFE Network.
3029
31-
3. Build SAFE Browser and open it.
30+
4. Build the SAFE Browser and open it:
3231
33-
```
34-
$ yarn run build
35-
$ yarn start
32+
```bash
33+
yarn run build
34+
yarn start
3635
```
3736
38-
If you're doing development, `yarn run watch` to have assets build automatically.
37+
If you're actively developing, you can use `yarn run watch` to have assets built automatically when they change.
3938

40-
6. Package SAFE Browser.
39+
5. Package the SAFE Browser for production:
4140

42-
```
43-
$ yarn run package
41+
```bash
42+
yarn run package
4443
```
4544

4645
The packed SAFE Browser will be found inside `dist` folder.
4746

48-
### Updating
47+
### Troubleshooting
4948

50-
If you pull latest from the repo and get weird module errors, do:
49+
If you pull the latest from the repo and get weird module errors, try:
5150

5251
```bash
53-
$ yarn run burnthemall
52+
yarn run burnthemall
5453
```
5554

56-
This will remove your node_modules, and do the full install, rebuild, build SAFE Authenticator and package processes for you. `yarn start` should work afterwards.
55+
This will remove your `node_modules` and do the full install, rebuild, build SAFE Authenticator, and package processes for you. After this, `yarn start` should work again.
56+
57+
## Further Help
58+
59+
You can discuss development-related questions on the [SAFE Dev Forum](https://forum.safedev.org/).
60+
Here's a good post to get started: [How to develop for the SAFE Network](https://forum.safedev.org/t/how-to-develop-for-the-safe-network-draft/843).
5761
5862
## License
5963

0 commit comments

Comments
 (0)