Miroirs/pinnacle
1
0
Fork 0
mirror of https://github.com/pinnacle-comp/pinnacle.git synced 2024-09-29 05:37:02 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README

Browse source 
Add API stability disclaimer
This commit is contained in:
Ottatop 2023-10-25 04:12:32 -05:00 committed by GitHub
parent 3ba7523e48
commit 2c67df1ffa
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -101,6 +101,14 @@ PINNACLE_CONFIG_DIR="./api/rust" cargo run
```
## Custom configuration
> [!IMPORTANT]
> Pinnacle is under heavy development, and there *will* be major breaking changes to these APIs
> until I release version 0.1, at which point there will be an API stability spec in place.
>
> Until then, I recommend you either use the out-of-the-box configs above or prepare for
> your config to break every now and then.
Pinnacle will search for a `metaconfig.toml` file in the following directories, from top to bottom:
```sh
$PINNACLE_CONFIG_DIR