Skip to content

Commit 774d3e5

Browse files
committed
README: Document library
Signed-off-by: Daniel Schaefer <dhs@frame.work>
1 parent 3b854e1 commit 774d3e5

1 file changed

Lines changed: 19 additions & 2 deletions

File tree

README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,15 +41,15 @@ You can find lots of examples in [EXAMPLES.md](./EXAMPLES.md).
4141
- [![Manjaro Testing package](https://repology.org/badge/version-for-repo/manjaro_testing/framework-system.svg)](https://repology.org/project/framework-system/versions)
4242
- [![Manjaro Unstable package](https://repology.org/badge/version-for-repo/manjaro_unstable/framework-system.svg)](https://repology.org/project/framework-system/versions)
4343
- `pacman -S framework-system`
44+
- [Cargo](https://crates.io/crates/framework_tool) (Any distro)
45+
- `cargo install --locked framework_tool`
4446
- Others
4547
- Build from source
4648
- Or download [latest binary](https://github.com/FrameworkComputer/framework-system/releases/latest/download/framework_tool)
4749
- ChromeOS
4850
- Build from source
4951
- Homebrew
5052
- Add [this homebrew tap](https://github.com/ublue-os/homebrew-tap), then `brew install --cask framework-tool`
51-
- Cargo (Any distro)
52-
- `cargo install --locked framework_tool`
5353

5454
### Windows
5555

@@ -65,6 +65,23 @@ winget install framework_tool --source winget
6565
sudo pkg install framework-system
6666
```
6767

68+
### Library
69+
70+
This project includes both a tool and a library, that you can use to build custom software.
71+
72+
The commandline does not guarantee a stable interface, it is intended for
73+
manual usage, for programmatic usage, please use [`framework_lib`](https://crates.io/crates/framework_lib).
74+
75+
The library is still in active development and does not guarantee stable
76+
interfaces. If you, as a user of the library have suggestions for improvements
77+
or requests for features, feel free to create an issue.
78+
To add it to your project add it to your `Cargo.toml`:
79+
80+
```
81+
[dependencies]
82+
framework_lib = "0.6.4"
83+
```
84+
6885
## Features
6986

7087
To check which features are supported on which OS and platform,

0 commit comments

Comments
 (0)