Skip to content

Commit 15709b2

Browse files
committed
chore(docs): Update README.md
1 parent 533bc33 commit 15709b2

File tree

3 files changed

+13
-10
lines changed

3 files changed

+13
-10
lines changed

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,24 @@
99

1010
An easy-to-use and lightweight API wrapper for Censys APIs ([censys.io](https://censys.io/)). Python 3.6+ is currently supported.
1111

12-
## Getting Started
12+
## Installation
1313

1414
The library can be installed using `pip`.
1515

1616
```bash
1717
pip install censys
1818
```
1919

20+
## Upgrading
21+
22+
The library can be upgraded using `pip`.
23+
24+
```bash
25+
pip install --upgrade censys
26+
```
27+
28+
## Getting Started
29+
2030
To configure your search credentials run `censys config` or set both `CENSYS_API_ID` and `CENSYS_API_SECRET` environment variables.
2131

2232
```bash
@@ -42,14 +52,6 @@ Successfully authenticated
4252

4353
[![Read the Docs](https://github.com/censys/censys-python/blob/main/docs/_static/readthedocs.png)](https://censys-python.readthedocs.io/)
4454

45-
## Upgrading
46-
47-
The library can be upgraded using `pip`.
48-
49-
```bash
50-
pip install --upgrade censys
51-
```
52-
5355
## Resources
5456

5557
- [Source](https://github.com/censys/censys-python)

docs/development.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ Install dependencies via ``pip``:
2727

2828
.. prompt:: bash $
2929

30+
cd censys-python/
3031
pip install -e ".[dev]"
3132

3233
Run the test suite with ``pytest``. More information about testing is available at :ref:`testing:Testing`.

docs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ The User Guide
2828
:maxdepth: 1
2929

3030
quick-start
31-
usage-v1
3231
usage-v2
32+
usage-v1
3333
usage-asm
3434
advanced-usage
3535

0 commit comments

Comments
 (0)