Skip to content

Commit 0964fb5

Browse files
authored
docs: update readme and docs landing page (#114)
1 parent d44c99c commit 0964fb5

File tree

4 files changed

+35
-6
lines changed

4 files changed

+35
-6
lines changed

README.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,18 @@
66
![PyPI - License](https://img.shields.io/pypi/l/rustac?style=for-the-badge)
77
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg?style=for-the-badge)](./CODE_OF_CONDUCT)
88

9-
A Python package for [STAC](https://stacspec.org/) using Rust under the hood.
9+
![The rustac logo](./img/rustac-small.png)
1010

11+
The power of Rust for the Python [STAC](https://stacspec.org/) ecosystem.
12+
13+
<!-- markdownlint-disable MD028 -->
1114
> [!TIP]
12-
> While you can pronounce "rustac" however you'd like, we like "ruh-stac".
15+
> We pronounce **rustac** "ruh-stac".
16+
17+
> [!NOTE]
18+
> Until 2025-04-17, this package was named **stacrs**.
19+
> See [this RFC](https://github.com/stac-utils/rustac/issues/641) for context on the name change.
20+
<!-- markdownlint-enable MD028 -->
1321
1422
## Why?
1523

@@ -25,6 +33,7 @@ If you don't need those things, **rustac** probably isn't for you — use **pyst
2533

2634
## Installation
2735

36+
**rustac** has zero required dependencies.
2837
Install via **pip**:
2938

3039
```shell
@@ -43,6 +52,7 @@ conda install conda-forge::rustac
4352

4453
### From source
4554

55+
You'll need [Rust](https://rustup.rs/).
4656
By default, **rustac** wants to find DuckDB on your system:
4757

4858
```shell
@@ -58,7 +68,7 @@ MATURIN_PEP517_ARGS="--features=duckdb-bundled" python -m pip install -U git+htt
5868

5969
## Usage
6070

61-
```python exec="on" source="above"
71+
```python
6272
import asyncio
6373
import rustac
6474

@@ -106,7 +116,7 @@ In particular, our [examples](https://stac-utils.github.io/rustac-py/latest/gene
106116

107117
**rustac** comes with a CLI:
108118

109-
```bash exec="on" source="above" result="text"
119+
```bash
110120
rustac -h
111121
```
112122

@@ -167,6 +177,10 @@ If you want to run an off-cycle docs update (e.g. if you fixed something and wan
167177
mike deploy [version] latest --push
168178
```
169179

180+
## Acknowledgements
181+
182+
We'd like to thank [@jkeifer](https://github.com/jkeifer), [@parksjr](https://github.com/parksjr), and Rob Gomez (all from [@Element84](https://github.com/Element84)) for creating the [rustac logo](./img/rustac.svg) from an AI-generated image from the prompt "a crab, a cabin, and a glass of whisky".
183+
170184
## License
171185

172186
**rustac-py** is dual-licensed under both the MIT license and the Apache license (Version 2.0).

docs/img/rustac-small.png

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../img/rustac-small.png

docs/index.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,18 @@
11
# rustac
22

3-
> The power of Rust for the Python STAC ecosystem.
3+
![The rustac logo](./img/rustac-small.png)
44

5-
**rustac** is a zero-dependency Python package for [STAC](https://stacspec.org/) using Rust under the hood.
5+
The power of Rust for the Python [STAC](https://stacspec.org/) ecosystem.
6+
7+
<!-- markdownlint-disable MD046-->
8+
!!! tip
9+
10+
We pronounce **rustac** "ruh-stac"
11+
12+
!!! note
13+
14+
Until 2025-04-17, this package was named **stacrs**.
15+
See [this RFC](https://github.com/stac-utils/rustac/issues/641) for context on the name change.
616

717
## Installation
818

@@ -29,3 +39,7 @@ asyncio.run(main())
2939
```
3040

3141
For more, see our [examples](./generated/gallery/index.md).
42+
43+
## Acknowledgements
44+
45+
We'd like to thank [@jkeifer](https://github.com/jkeifer), [@parksjr](https://github.com/parksjr), and Rob Gomez (all from [@Element84](https://github.com/Element84/)) for creating the rustac logo from an AI-generated image from the prompt "a crab, a cabin, and a glass of whisky".

img/rustac-small.png

61.7 KB
Loading

0 commit comments

Comments
 (0)