Skip to content

Commit

Permalink
Add small documentation fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
thunderbiscuit committed Jan 7, 2024
1 parent 827df12 commit 0f98d48
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
6 changes: 4 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# About [cashu-client](https://github.com/thunderbiscuit/cashu-client)
# About
A Kotlin Multiplatform client library to interact with the [Cashu protocol].

---

This website provides high-level documentation for understanding and leveraging the [cashu-client](https://github.com/thunderbiscuit/cashu-client) library. You can read our [API docs here](https://thunderbiscuit.github.io/cashu-client/).
This website provides high-level documentation for understanding and leveraging the [cashu-client] library. You can read our [API docs here].

The main goals of this library are:

Expand All @@ -24,3 +24,5 @@ The main goals of this library are:
<br>

[Cashu protocol]: https://github.com/cashubtc/nuts
[cashu-client]: https://github.com/thunderbiscuit/cashu-client
[API docs here]: ./api/
2 changes: 1 addition & 1 deletion docs/install.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Install and Build Instructions
The library is not available on Maven Central; to use, you must build and deploy locally.
The library is not available on Maven Central. To use it, you must build and deploy locally.

To build the library locally and deploy to your local Maven repository, clone the git repository and run the following command:
```shell
Expand Down

0 comments on commit 0f98d48

Please sign in to comment.