Skip to content

Commit 670a3d3

Browse files
committed
WIP: Update new README.md p1
1 parent 230496f commit 670a3d3

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

+17
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,13 @@
11
# pywaveshare
22

3+
*If you are looking for the old README, then you can check it out [here](https://github.com/acmacunlay/pywaveshare/blob/main/README.old.md).*
4+
35
## 1. Introduction
46

57
### 1.1. Purpose
8+
9+
This project attempts to wrap all features and functionalities of [Waveshare GSM/GPRS/GNSS HAT for Raspberry Pi](https://www.waveshare.com/gsm-gprs-gnss-hat.htm) in a simple interface.
10+
611
### 1.2. Scope
712
### 1.3. Audience
813

@@ -18,6 +23,18 @@
1823
### 3.2. System Requirements
1924
### 3.3. Installation Steps
2025

26+
You can download the stable version in `pypi` using `pip`:
27+
28+
```shell
29+
pip install pywaveshare
30+
```
31+
32+
If the user wants to test out the version under development, then download the package from test.pypi.org using `pip`:
33+
34+
```shell
35+
pip install -i https://test.pypi.org/simple/ pywaveshare
36+
```
37+
2138
## 4. Configuration
2239

2340
### 4.1. Configuration Parameters

0 commit comments

Comments
 (0)