Skip to content

Commit cb88384

Browse files
committed
docs: improved readbility and consistent now
1 parent 548c0ad commit cb88384

19 files changed

Lines changed: 647 additions & 5401 deletions

README.md

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,26 @@
55

66
Portal is a Nostr-based authentication and payment SDK allowing applications to authenticate users and process payments through Nostr and Lightning Network.
77

8-
Use the [TypeScript](https://www.npmjs.com/package/portal-sdk) or [Java](https://github.com/PortalTechnologiesInc/java-sdk) SDK, or run the API yourself.
9-
10-
**[Official Documentation](https://portaltechnologiesinc.github.io/lib/)**
8+
**Documentation:** [portaltechnologiesinc.github.io/lib](https://portaltechnologiesinc.github.io/lib/)
119

1210
---
1311

14-
### Quick start (Docker)
12+
## Repository
13+
14+
| Crate / package | Description |
15+
|-----------------|-------------|
16+
| portal-rest | API server (REST + WebSocket). Run with Docker or from source. |
17+
| portal | Core protocol and conversation logic. |
18+
| portal-app | App runtime and wallet integration. |
19+
| portal-cli | CLI tools (JWT, invoices, Cashu, etc.). |
20+
| portal-wallet | Wallet backends (NWC, Breez). |
21+
| portal-rates | Fiat exchange rates for BTC/sats. |
22+
| clients/ts | TypeScript SDK ([npm](https://www.npmjs.com/package/portal-sdk)). |
23+
| Java SDK | [PortalTechnologiesInc/java-sdk](https://github.com/PortalTechnologiesInc/java-sdk). |
24+
25+
## Quick start
26+
27+
**Run the API (Docker):**
1528

1629
```bash
1730
docker run -d -p 3000:3000 \
@@ -20,8 +33,10 @@ docker run -d -p 3000:3000 \
2033
getportal/sdk-daemon:latest
2134
```
2235

23-
For setup, SDK usage, and guides, see the [documentation](https://portaltechnologiesinc.github.io/lib/).
36+
Then use `ws://localhost:3000/ws` and your token with the [TypeScript](https://www.npmjs.com/package/portal-sdk) or [Java](https://github.com/PortalTechnologiesInc/java-sdk) SDK. See [Quick Start](https://portaltechnologiesinc.github.io/lib/getting-started/quick-start.html) in the docs.
37+
38+
**Build from source:** [Building from source](https://portaltechnologiesinc.github.io/lib/getting-started/building-from-source.html)`cargo build --package portal-rest --release` or `nix build .#rest`.
2439

2540
---
2641

27-
**License:** MIT. See [LICENSE](LICENSE).
42+
**License:** MIT [LICENSE](LICENSE)

0 commit comments

Comments
 (0)