From 4f4bc49b430da897a1ea318015c0f278e8b64c6b Mon Sep 17 00:00:00 2001
From: Mylloon <kennel.anri@tutanota.com>
Date: Tue, 16 Aug 2022 18:48:16 +0200
Subject: [PATCH] update metadata

---
 Cargo.toml | 18 ++++++++----------
 README.md  | 21 ++++++++++++++++++---
 2 files changed, 26 insertions(+), 13 deletions(-)

diff --git a/Cargo.toml b/Cargo.toml
index 3a09cff..6e70b3a 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,22 +1,20 @@
 [package]
 name = "cal8tor"
 version = "0.1.0"
+authors = ["Mylloon"]
 edition = "2021"
-
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+description = "Extractor of the calendar of the IT degree of university Paris 8"
+readme = "README.md"
+repository = "https://git.kennel.ml/Anri/cal8tor"
+keywords = ["scrape", "calendar"]
+publish = false
 
 [dependencies]
 reqwest = { version = "0.11" }
 tokio = { version = "1", features = ["full"] }
-scraper = "0.13.0"
+scraper = "0.13"
 regex = "1"
 chrono = "0.4"
 ics = "0.5"
+uuid = { version = "1.1", features = ["v4", "fast-rng"] }
 clap = { version = "3.2", features = ["derive"] }
-
-[dependencies.uuid]
-version = "1.1.2"
-features = [
-    "v4",                # Lets you generate random UUIDs
-    "fast-rng",          # Use a faster (but still sufficiently random) RNG
-]
diff --git a/README.md b/README.md
index 5825372..245dd22 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,19 @@
 # cal8tor • **cal**endar P**8** extrac**tor**
-WIP
-<!-- tz support only in the .ical output -->
-<!-- .ical output in compliance with https://icalendar.org/validator.html -->
+Extractor of the calendar of the IT degree of university Paris 8.
+
+## **WIP:** See the calendar in your terminal
+Run for example the L2-X:
+```bash
+$ ./cal8tor --class 2 --letter X
+```
+
+## **WIP:** Export the calendar in .ics format
+Run for example the L1-A:
+```bash
+$ ./cal8tor --class 1 --letter A --export calendar.ics
+```
+
+> The file include the timezone for `Europe/Paris` and is in compliance with [this validator tool](https://icalendar.org/validator.html).
+
+---
+Please open a PR if you want to improve the project!