Skip to content

Commit 380d9a3

Browse files
authored
docs: update readmes with pacakge manager references (#165)
1 parent b71d75b commit 380d9a3

File tree

1 file changed

+8
-20
lines changed

1 file changed

+8
-20
lines changed

README.md

Lines changed: 8 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -6,41 +6,29 @@ This repo defines Python, Swift, and Kotlin bindings for [iroh](https://github.c
66

77
### Published Packages:
88

9-
[Python](https://pypi.org/project/iroh/)
10-
[Swift](https://github.com/n0-computer/iroh-ffi)
9+
[Python: pypi](https://pypi.org/project/iroh/)
10+
[Swift: Cocoapods](https://cocoapods.org/pods/IrohLib)
11+
[Swift: SwifPM](https://swiftpackageindex.com/n0-computer/iroh-ffi)
12+
[Rust: Crates](https://crates.io/crates/iroh)
1113

1214
## Repo Status: Tier 2
1315

1416
This is a "tier 2" repo, which means it's a repo we care about, but don't apply the same level of rigor as a "tier 1" repo. All work is done through pull requests and must pass continuous integration, but the peer review process is much lighter, and our reaction times to issues will not be as fast as tier 1 repositories.
1517

1618
If you're blocked on something or need to draw attention to an issue, please reach out to the iroh [discord](https://discord.gg/B4pzE3usDC).
1719

18-
## Releases
19-
20-
We are _not_ committed to publishing releases for the FFI on a schedule or in tandem with the latest version of [iroh](https://github.com/n0-computer/iroh), but we try. There may be a gap between the latest version of `iroh` (or the latest version of `iroh-ffi` that is released on GitHub), and the matching versions of the Python or Swift ffi languages that are published.
21-
22-
If there currently is a gap, and you need a published Python or Swift package, please file an issue or reach out to us on our [discord](https://discord.gg/B4pzE3usDC).
23-
2420

2521
## Library Compilation
2622

2723
Running `cargo build --release` will produce a dynamic library and a static library.
2824

2925
For builds targeting older versions of macOS, build with: `MACOSX_DEPLOYMENT_TARGET=10.7 && cargo build --target x86_64-apple-darwin --release`.
3026

31-
## Language Specifics
32-
33-
### Swift
34-
35-
[Notes here](https://github.com/n0-computer/iroh-ffi/blob/main/README.swift.md)
36-
37-
### Python
38-
39-
[Notes here](https://github.com/n0-computer/iroh-ffi/blob/main/README.python.md)
40-
41-
### Kotlin
27+
## Language-Specific READMEs
4228

43-
[Notes here](https://github.com/n0-computer/iroh-ffi/blob/main/README.kotlin.md)
29+
* [**Swift readme**](https://github.com/n0-computer/iroh-ffi/blob/main/README.swift.md)
30+
* [**Python readme**](https://github.com/n0-computer/iroh-ffi/blob/main/README.python.md)
31+
* [**Kotlin readme**](https://github.com/n0-computer/iroh-ffi/blob/main/README.kotlin.md)
4432

4533
## Developers
4634
Check our [DEVELOPERS.md](DEVELOPERS.md) for guides on how to translate from the iroh rust API to the iroh FFI API, as well as how to set up testing for Golang and Python.

0 commit comments

Comments
 (0)