Skip to content

Commit 7430e52

Browse files
authored
Merge pull request #55 from nitrictech/feature/fix-readme
docs: update readme
2 parents 929f9f3 + 9853f6f commit 7430e52

1 file changed

Lines changed: 15 additions & 21 deletions

File tree

README.md

Lines changed: 15 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -8,42 +8,36 @@
88

99
# Nitric Python SDK
1010

11-
The Python SDK supports the use of the cloud-portable [Nitric](https://nitric.io) framework with Python 3.7+.
11+
The Python SDK supports the use of the cloud-portable [Nitric](https://nitric.io) framework with Python 3.
1212

1313
> The Nitric Python SDK is currently in Preview, API changes are likely prior to v1.x release.
1414
1515
Read full documentation [here](https://nitrictech.github.io/python-sdk/).
1616

17-
## Usage
17+
## Prerequisites
18+
19+
- Python 3.8+
20+
21+
## Getting Started
1822

19-
### Nitric Functions (FaaS):
23+
### Using the [Nitric CLI](https://github.com/nitric-tech/cli)
2024

21-
- Install Python 3.7+
22-
- Install the [Nitric CLI](https://nitric.io/docs/installation?lang=python)
23-
- Create / Open a Nitric Project
24-
- Make a Python37 function
25-
26-
```bash
27-
# Create a new project
28-
nitric make:project example-python
29-
cd example-python
25+
> nitric is included in all python related projects by default
3026
31-
# Create a python37 Nitric Function
32-
nitric make:service function/python37 example-function
27+
```bash
28+
nitric make:stack
3329
```
3430

35-
> note: The SDK will be included in the requirements.txt of a new Python function by default.
31+
Then select `official/Python Stack`
3632

37-
### Standard Python Project
33+
### Adding to an existing project
3834

39-
- Install Python 3.7+
35+
**pip**
4036

4137
```bash
4238
# Install the Nitric SDK
4339
pip3 install nitric
4440
```
4541

46-
```python
47-
# import classes/modules as required
48-
from nitric.api import Events, KeyValueClient
49-
```
42+
## Usage
43+
[Nitric Documentation](https://nitric.io/docs)

0 commit comments

Comments
 (0)