Skip to content

Commit 54050b1

Browse files
committed
Add note about v2.0 development
1 parent 2818bfa commit 54050b1

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,14 @@
55
[![CircleCI](https://circleci.com/gh/elixir-circuits/circuits_spi.svg?style=svg)](https://circleci.com/gh/elixir-circuits/circuits_spi)
66
[![REUSE status](https://api.reuse.software/badge/github.com/elixir-circuits/circuits_spi)](https://api.reuse.software/info/github.com/elixir-circuits/circuits_spi)
77

8-
`Circuits.SPI` provides high level abstractions for interfacing to SPI buses on
9-
Linux platforms. Internally, it uses the [Linux device
10-
interface](https://elixir.bootlin.com/linux/latest/source/Documentation/spi/spidev)
11-
so that it does not require board-dependent code.
8+
`Circuits.SPI` lets you communicate with hardware devices using the SPI
9+
protocol.
10+
11+
*This is the v1 maintenance branch. This is the version you want for production
12+
use now. To follow v2.0 development, see the [circuits_spi v2.0
13+
branch](https://github.com/elixir-circuits/circuits_spi/tree/v2.0)*
14+
15+
If you're coming from Elixir/ALE, check out our [porting guide](PORTING.md).
1216

1317
## Getting started
1418

@@ -17,7 +21,7 @@ support, then add `circuits_spi` like any other Elixir library:
1721

1822
```elixir
1923
def deps do
20-
[{:circuits_spi, "~> 1.3"}]
24+
[{:circuits_spi, "~> 1.4"}]
2125
end
2226
```
2327

0 commit comments

Comments
 (0)