summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFredrik Meringdal <fmeringdal@hotmail.com>2020-10-25 01:33:33 +0200
committerFredrik Meringdal <fmeringdal@hotmail.com>2020-10-25 01:33:33 +0200
commit6acba0e4ee286a6412261a89ad15db01717ac8bc (patch)
tree98a553ad25a2a634112a0b146593e7099582df4c /README.md
parentea7f196d627868a7cde403e35421a1f085d84b92 (diff)
downloadrust_rrule-6acba0e4ee286a6412261a89ad15db01717ac8bc.zip
small refactor
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 21 insertions, 2 deletions
diff --git a/README.md b/README.md
index 54ceb0d..ffd7ad8 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,31 @@
-# RRule implemented in Rust for speed
+# RRule in rust
+
[![Build](https://travis-ci.com/fmeringdal/rust_rrule.svg?branch=main)](https://travis-ci.com/fmeringdal/rust_rrule)
[![codecov](https://codecov.io/gh/fmeringdal/rust_rrule/branch/main/graph/badge.svg)](https://codecov.io/gh/fmeringdal/rust_rrule)
[![crates.io](https://img.shields.io/crates/v/rrule.svg)](https://crates.io/crates/rrule)
-Fast implementation of rrule
+A pure Rust partial implementation of recurrence rules as defined in the iCalendar RFC.
+
+# Usage
+
+```rust
+extern crate rrule;
+
+use rrule::build_rrule;
+let mut rrule_set = build_rule("RRULE:UNTIL=19990404T110000Z;DTSTART;TZID=America/New_York:19990104T110000Z;FREQ=WEEKLY;BYDAY=TU,WE");
+
+// Get all occurrences of the rrule set
+let occurences = rrule_set.all();
+```
+
+# Inspired by
+
+- [python-dateutil library](http://labix.org/python-dateutil/)
+- [rrule.js](https://github.com/jakubroztocil/rrule)
# todos
+
- tests for minutes and seconds FREQ
- timezone
- subseconds