Merge pull request #4 from siketyan/library

✨ Turn into library
siketyan · Dec 18, 2020 · 36596fa · 36596fa
2 parents 733b939 + 22842bb
commit 36596fa
Show file tree

Hide file tree

Showing 8 changed files with 267 additions and 164 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1 +1,2 @@
 /target
+/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,14 @@
 [package]
 name = "schetube"
+description = "A library to fetch upcoming live streams from a YouTube channel."
 version = "0.1.0"
+license = "MIT"
+license-file = "LICENCE.md"
+readme = "README.md"
+homepage = "https://github.com/siketyan/schetube"
+repository = "https://github.com/siketyan/schetube.git"
+documentation = "https://github.com/siketyan/schetube/#readme"
+keywords = ["rust-library", "youtube", "live-streams"]
 authors = ["Naoki Ikeguchi <[email protected]>"]
 edition = "2018"
 

diff --git a/README.md b/README.md
@@ -1,15 +1,19 @@
 # schetube
-A CLI tool to fetch upcoming live streams from a YouTube channel.
+A library to fetch upcoming live streams from a YouTube channel.
 
-## Installation
-```
-$ git clone https://github.com/siketyan/schetube.git
-$ cd schetube
-$ cargo build --release
-$ ln -s "$(pwd)/target/release/schetube" /usr/local/bin/schetube
+## 📦 Installation
+```toml
+[dependencies]
+schetube = "0.1"
 ```
 
-## Usage
+## 💚 Example
+```
+$ cd ./example
+$ cargo run [Channel ID]
 ```
-$ schetube [Channel ID]
+
+## 🔌 API
+```rust
+pub async fn fetch_upcoming_videos(channel_id: &str) -> Result<Vec<Video>, Box<dyn Error>>;
 ```
diff --git a/example/.gitignore b/example/.gitignore
@@ -0,0 +1 @@
+/target