diff --git a/.gitignore b/.gitignore
index 50b79635..749d5493 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,4 +1,5 @@
node_modules/
bower_components/
.idea
-.vscode
\ No newline at end of file
+.vscode
+*.log
\ No newline at end of file
diff --git a/README.md b/README.md
index e3b31269..7c9b68c5 100644
--- a/README.md
+++ b/README.md
@@ -31,10 +31,10 @@ $ yarn add rrule
```
Alternatively, download
-[rrule.js](https://raw.github.com/jakubroztocil/rrule/master/dist/index.js) manually.
+[rrule.js](https://raw.github.com/jakubroztocil/rrule/master/dist/es5/rrule.js) manually.
```html
-
+
```
#### Server Side
@@ -43,10 +43,8 @@ Alternatively, download
$ yarn add rrule
```
-```javascript
-var RRule = require('rrule').RRule
-var RRuleSet = require('rrule').RRuleSet
-var rrulestr = require('rrule').rrulestr
+```es6
+import { RRule, RRuleSet, rrulestr } from 'rrule'
```
#### Usage
@@ -54,7 +52,7 @@ var rrulestr = require('rrule').rrulestr
**RRule:**
```js
// Create a rule:
-var rule = new RRule({
+const rule = new RRule({
freq: RRule.WEEKLY,
interval: 5,
byweekday: [RRule.MO, RRule.FR],
@@ -88,7 +86,7 @@ rule.toText()
**RRuleSet:**
```js
-var rruleSet = new RRuleSet()
+const rruleSet = new RRuleSet()
// Add a rrule to rruleSet
rruleSet.rrule(new RRule({
@@ -338,7 +336,6 @@ documentation.
rule.options.byweekday
isn't equal
to rule.origOptions.byweekday
(which is an inconsistency).
-
rule.origOptions
options
argument passed to
the constructor.count
to see more.
+ rule =
+ |
+ + + | +
---|---|
+ rule.origOptions
+ |
+ + + | +
+ rule.toString()
+ |
+
+ + |
+
+ rule.toText()
+ |
+ + + + + | +
+ rule.all()
+ |
+
+ |
+
RRULE
string+ +
+
+ Enter an
+ RRULE
as per
+ iCalendar RFC.
+
Examples:
+FREQ=WEEKLY;BYDAY=MO,WE
+ FREQ=MONTHLY;BYMONTHDAY=10,15;COUNT=20
+ FREQ=DAILY;INTERVAL=3;COUNT=10
+ FREQ=MONTHLY;BYDAY=-2FR;COUNT=7
+ + +
+Examples:
+Every weekday
+ Every 2 weeks on Tuesday
+ Every week on Monday, Wednesday
+ Every month on the 2nd last Friday for 7 times
+ Every 6 months
+