Skip to content

Commit b8d73f1

Browse files
committed
added readme
1 parent bf9cf42 commit b8d73f1

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

readme.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# RRule
2+
3+
[![GoDoc](https://godoc.org/github.com/stephens2424/rrule?status.svg)](https://godoc.org/github.com/stephens2424/rrule)
4+
5+
Package RRule implements recurrence processing according to RFC 5545. See the
6+
[godoc](https://godoc.org/github.com/stephens2424/rrule) for usage information.
7+
8+
This implementation was written to overcome performance issues in previous
9+
implementations. Those previous ones were generally implemented as direct
10+
translations of the venerable python-dateutil, however the algorithms were
11+
complicated and probably didn't use Go's language features effectively enough
12+
for performance optimization. The observed problem was particularly acute under
13+
GopherJS.
14+
15+
The library here is essentially complete. A fair number of various patterns are
16+
tested, particularly simple ones. The library has not seen, at the time of this
17+
writing, any production usage, however. Issue reports with implementation
18+
accuracy or performance problems are particularly welcome.
19+
20+
Licensed under BSD-3. See the LICENSE file.

0 commit comments

Comments
 (0)