Skip to content

Commit 6d256cb

Browse files
authored
Update README.md
1 parent 2ba987f commit 6d256cb

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,19 @@
11
# The official QFieldCloud SDK and CLI
22

3-
`qfieldcloud-sdk` is the official client to connect to QFieldCloud API either as a python module, or directly from the command line.
3+
`qfieldcloud-sdk` is the official client to connect to QFieldCloud API either as a Python module, or directly from the command line interface (CLI).
44

55
## Contents
66

7+
- [Documentation](#documentation)
78
- [Installation](#install)
89
- [CLI usage](#cli-usage)
910
- [Module usage](#module-usage)
1011

11-
## Install
12+
## Documentation
13+
14+
[QFieldCloud SDK Documentation](https://opengisch.github.io/qfieldcloud-sdk-python/)
15+
16+
## Installation
1217

1318
### Linux/macOS
1419

@@ -22,7 +27,7 @@ Install Python with your favorite package manager. Then:
2227

2328
## CLI usage
2429

25-
The package also ships with the official QFieldCloud CLI tool.
30+
The package provides the official QFieldCloud CLI tool.
2631

2732
### Usage
2833

@@ -45,7 +50,7 @@ export QFIELDCLOUD_TOKEN=017478ee2464440cb8d3e98080df5e5a
4550
qfieldcloud-cli --json list-projects
4651
```
4752

48-
More detailed documentation can be found [here](https://docs.qfield.org/reference/qfieldcloud/sdk/)
53+
Check [the examples page](https://opengisch.github.io/qfieldcloud-sdk-python/examples/) in the documentation for more examples.
4954

5055
## Module usage
5156

@@ -95,12 +100,14 @@ pre-commit install
95100
# install package in a virtual environment
96101
pipenv install -r requirements.txt
97102
```
103+
98104
To run CLI interface for development purposes execute:
99105

100106
```shell
101107
pipenv shell # if your pipenv virtual environment is not active yet
102108
python -m qfieldcloud_sdk
103109
```
110+
104111
To ease development, you can set a `.env` file. Therefore you can use directly the `qfieldcloud-cli` executable:
105112
```
106113
cp .env.example .env

0 commit comments

Comments
 (0)