Compare commits

...

2 commits

Author SHA1 Message Date
askiiart
162f03fced
switch from rs to rust to work properly with cargo doc 2024-11-30 01:15:34 -06:00
askiiart
cf7a3b7d53
update README 2024-11-30 01:15:05 -06:00
3 changed files with 5 additions and 5 deletions

View file

@ -4,7 +4,7 @@ A safe, multi-threaded toolkit for adding Torznab APIs to programs. You just foc
Just fill in your own relevant functions and config, and torznab-toolkit will run the API for you Just fill in your own relevant functions and config, and torznab-toolkit will run the API for you
```rs ```rust
use torznab_toolkit; use torznab_toolkit;
let config: torznab_toolkit::config::Config = /* config goes here */ let config: torznab_toolkit::config::Config = /* config goes here */
@ -23,7 +23,7 @@ Note: I wrote the line above when I was tired. Don't ask me what *literal* truck
| API call | Explanation | Implemented | | API call | Explanation | Implemented |
| -------- | ------------------------------------------------------------ | ----------- | | -------- | ------------------------------------------------------------ | ----------- |
| caps | Returns the capabilities of the api. | | | caps | Returns the capabilities of the api. | |
| search | Free text search query. | ❌ | | search | Free text search query. | ❌ |
| tvsearch | Search query with tv specific query params and filtering. | ❌ | | tvsearch | Search query with tv specific query params and filtering. | ❌ |
| movie | Search query with movie specific query params and filtering. | ❌ | | movie | Search query with movie specific query params and filtering. | ❌ |

View file

@ -11,7 +11,7 @@
example usage: example usage:
```rs ```rust
let config = /* config goes here */ let config = /* config goes here */
fn main() -> Result { fn main() -> Result {
@ -25,7 +25,7 @@ fn main() -> Result {
Queries are returned as an RSS feed something like this: Queries are returned as an RSS feed something like this:
```rss ```rusts
<rss version="1.0" xmlns:atom="http://www.w3.org/2005/Atom" xmlns:torznab="http://torznab.com/schemas/2015/feed"> <rss version="1.0" xmlns:atom="http://www.w3.org/2005/Atom" xmlns:torznab="http://torznab.com/schemas/2015/feed">
<channel> <channel>
<atom:link rel="self" type="application/rss+xml" /> <atom:link rel="self" type="application/rss+xml" />

View file

@ -6,7 +6,7 @@ use std::collections::HashMap;
/// HashMap equivalent of vec![] /// HashMap equivalent of vec![]
/// ///
/// Example: /// Example:
/// ```rs /// ```rust
/// hashmap!(("key", "value")) /// hashmap!(("key", "value"))
/// ``` /// ```
macro_rules! hashmap { macro_rules! hashmap {