mleku/orly
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update readme with clarification on features and repository policy

Browse Source 
- **readme.adoc**:
  - Added "(todo: this is mostly built and designed but not currently available)" to a listed feature for better transparency on availability.
  - Clarified that the branch name is `main` instead of `dev` under repository policy.
  - Noted that "Simplified Nostr" is not currently implemented and marked it as "coming soon".
This commit is contained in:
mleku
2025-07-17 13:59:45 +01:00
parent 1d18425677
commit 2323545d4b
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
readme.adoc
View File

@@ -13,7 +13,7 @@ and https://github.com/fiatjaf/relayer[fiatjaf/relayer] aimed at maximum perform
== Features
* new HTTP REST API available in addition to standard websocket access, simplifying writing applications and tools, and building a standard API method set for future extensions for more flexible features.
* a lot of other bits and pieces accumulated from nearly 8 years of working with Go, logging and run control, XDG user data directories (windows, mac, linux, android)
* a lot of other bits and pieces accumulated from nearly 8 years of working with Go, logging and run control, XDG user data directories (windows, mac, linux, android) (todo: this is mostly built and designed but not currently available)
* a cleaned up and unified fork of the btcd/dcred BIP-340 signatures, including the use of bitcoin core's BIP-340 implementation (more than 4x faster than btcd) (todo: ECDH from the C library tbd).
* AVX/AVX2 optimized SHA256 and SIMD hex encoder
* https://github.com/bitcoin/secp256k1[libsecp256k1]-enabled signature and signature verification (see link:p256k/README.md[here]).
@@ -35,7 +35,7 @@ Go 1.24 or better is required.
== Repository Policy
In general, the main `dev` branch will build, but occasionally may not.
In general, the `main` branch will build, but occasionally may not.
It is where new commits are added once they are working, mostly, and allows people to easily see ongoing activity.
WARNING: IT IS NOT GUARANTEED TO BE STABLE... but it is getting there.
@@ -113,6 +113,8 @@ The database is stored in `$HOME/.local/share/orly` and if need be you can stop
[#_simplified_nostr]
=== Simplified Nostr
NOTE: this is not currently implemented. coming soon TM
Rather than write a text that will likely fall out of date very quickly, simply run `orly` and visit its listener address (eg link:http://localhost:3334/api[http://localhost:3334/api]) to see the full documentation.
By default this presents you with a Scalar Docs page that lets you browse the available API methods and shows examples in many forms including cURL and most languages how to call and what data needs to go in headers, body, and parameters and what results will come back.