summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMatthias Beyer <mail@beyermatthias.de>2019-12-20 20:48:32 +0100
committerGitHub <noreply@github.com>2019-12-20 20:48:32 +0100
commitfe21dea3e9d861d5149f1a23eec1580b05259c30 (patch)
treeb0e54801b1244387558ebb594616f3c615e0dcd0
parent1380db01f8d1cc813c7b7f9d42b75cad4318e845 (diff)
parent7ec921847e50c7aca06a21c7947cfb7240703946 (diff)
Merge pull request #12 from matthiasbeyer/update-readme
Rewrite README file with more information about this project
-rw-r--r--README.md13
1 files changed, 10 insertions, 3 deletions
diff --git a/README.md b/README.md
index f7203a3..6e13752 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,18 @@
# libical
-High-level interface for libical-sys.
+This library aims to be a high-level idomatic Rust crate for ical data handling
+and manipulation. It uses the famous
+[libical](https://libical.github.io/libical/) via the
+[libical-sys](https://github.com/Valodim/libical-sys) crate.
-## Status
+## Status / Progress
-**WIP. DO NOT USE.**
+* v0.2.0 is a (pending) refactoring effort to make this library more idomatic
+ for rust development.
+* [v0.1.0](https://crates.io/crates/libical) was published after the codebase
+ was extracted from the [khaleesii](https://github.com/Valodim/khaleesi)
+ project.
## License