Skip to content

Commit

Permalink
docs: better README formatting (#37)
Browse files Browse the repository at this point in the history
  • Loading branch information
Alan Shaw authored Dec 18, 2023
1 parent 107d930 commit 5427554
Showing 1 changed file with 12 additions and 20 deletions.
32 changes: 12 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,17 @@

> IPFS install manager
# About
## Install

## Example - Use the latest version of Kubo
```console
$ npm i -g iim
```

Note: Windows not yet supported!

## Usage

**Example - Use the latest version of Kubo**

```sh
$ iim use kubo
Expand All @@ -28,7 +36,7 @@ $ ipfs version
kubo version: 0.24.0
```

## Example - Use Kubo at version 0.23.0
**Example - Use Kubo at version 0.23.0**

```sh
$ iim use kubo 0.23
Expand Down Expand Up @@ -74,22 +82,6 @@ Don't worry! Mostly everything worked fine - you just don't have permission to w

Feel free to dive in! [Open an issue](https://github.com/alanshaw/iim/issues/new) or submit PRs.

# Install

```console
$ npm i iim
```

Note: Windows not yet supported!

# API Docs

- <https://alanshaw.github.io/iim>

# License
## License

[MIT](LICENSE) © Alan Shaw

# Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

0 comments on commit 5427554

Please sign in to comment.