aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/api.md15
1 files changed, 5 insertions, 10 deletions
diff --git a/doc/api.md b/doc/api.md
index 2d0dd9a..305430d 100644
--- a/doc/api.md
+++ b/doc/api.md
@@ -1,9 +1,3 @@
-# Jellything Rust API
-
-For making your own applications that implement client functionality, use the
-`jellyclient` crate. The `jellycommon` crate exposes commonly used structs like
-those used in the library and for jhls.
-
## Generated Documentation
- [jellything](/doc/jellything/)
@@ -12,7 +6,6 @@ those used in the library and for jhls.
- [jellytranscode](/doc/jellytranscode/)
- [jellyimport](/doc/jellyimport/)
- [jellymatroska](/doc/jellymatroska/)
- - [ebml_derive](/doc/ebml_derive/)
- [jellybase](/doc/jellybase/)
- [jellystream](/doc/jellystream/)
- [jellytool](/doc/jellytool/)
@@ -24,9 +17,11 @@ Most endpoints require the `Accept` header to be present and set to
will report errors with an object containing error string in the `error` key.
Routes marked with `*` require authentification.
-The `jellyclient` crate already implements most API functionality. The
-`jellycommon` crate provides useful structs for deserializing data (also
-reexported in jellyclient).
+## Rust API Wrapper
+
+For making your own applications that implement client functionality in Rust,
+use the `jellyclient` crate. The `jellycommon` crate exposes commonly used
+structs like those used in the library and for jhls.
```toml
# Cargo.toml