Skip to content

Commit

Permalink
Various minor readme updates
Browse files Browse the repository at this point in the history
  • Loading branch information
fhunleth committed Nov 23, 2020
1 parent b9c0694 commit 5e636d3
Showing 1 changed file with 9 additions and 10 deletions.
19 changes: 9 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ changes to your Nerves projects:
These changes enable NervesHub to provide assurances that the firmware bits
you intend to install on a set of devices make it to those devices unaltered.

## Getting Started
## Getting started

The following sections will walk you through updating your Nerves project to
work with the [nerves-hub.org](https://nerves-hub.org) NervesHub server. Using
Expand All @@ -53,8 +53,8 @@ list:
```elixir
defp deps do
[
{:nerves, "~> 1.3", runtime: false},
{:nerves_hub_cli, "~> 0.1", runtime: false}
{:nerves, "~> 1.7", runtime: false},
{:nerves_hub_cli, "~> 0.10", runtime: false}
...
] ++ deps(@target)
end
Expand Down Expand Up @@ -85,8 +85,8 @@ your dependencies. For example:
```elixir
defp deps(target) do
[
{:nerves_runtime, "~> 0.9"},
{:nerves_hub_link, "~> 0.1"},
{:nerves_runtime, "~> 0.11"},
{:nerves_hub_link, "~> 0.9"},
{:nerves_time, "~> 0.2"},
...
] ++ system(target)
Expand All @@ -112,15 +112,14 @@ the SSL options for you by enabling add it as a dependency:
```elixir
def deps() do
[
{:nerves_hub_link, "~> 0.7"},
{:nerves_key, "~> 0.5"}
]
end
```

NervesKey will default to using i2c bus 1 and `:primary` certificate pair.
However, you can customize these options as well to use
a different bus and certificate pair:
NervesKey will default to using I2C bus 1 and the `:primary` certificate pair
(`:primary` is one-time configurable and `:aux` may be updated). You can
customize these options to use a different bus and certificate pair:

```elixir
config :nerves_hub_link, :nerves_key,
Expand Down Expand Up @@ -151,7 +150,7 @@ config :nerves_hub_link,
]
```

### Runtime Configuration
### Runtime configuration

Some cases require that connection configuration happens at runtime like
selectively choosing which cert/key to use based on device, or reading a file
Expand Down

0 comments on commit 5e636d3

Please sign in to comment.