Skip to content

Commit 1cba09f

Browse files
committed
update example
1 parent 0dc605c commit 1cba09f

File tree

1 file changed

+31
-11
lines changed

1 file changed

+31
-11
lines changed

README.md

Lines changed: 31 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -68,11 +68,15 @@ A cool description (optional).
6868
## 2.2.3-pre.1 - 2013-02-14
6969
* Update API
7070

71-
## 1.0.0-x.7.z.92 - 2013-02-14
71+
## 2.0.0-x.7.z.92 - 2013-02-14
7272
* bark bark
7373
* woof
7474
* arf
7575

76+
## v1.3.0
77+
78+
* make it so
79+
7680
## [1.2.3](link)
7781
* init
7882

@@ -82,17 +86,33 @@ A cool description (optional).
8286
Parsing the above example will return the following object:
8387

8488
```js
85-
{ versions:
86-
[ { version: 'unreleased', body: '* foo' },
87-
{ version: 'x.y.z', body: '* bar' },
88-
{ version: 'a.b.c',
89-
body: '### Changes\n\n* Update API\n* Fix bug #1' },
90-
{ version: '2.2.3-pre.1', body: '* Update API' },
91-
{ version: '1.0.0-x.7.z.92',
92-
body: '* bark bark\n* woof\n* arf' },
93-
{ version: '1.2.3', body: '* init' } ],
89+
{
9490
title: 'changelog title',
95-
description: 'A cool description (optional).' }
91+
description: 'A cool description (optional).',
92+
versions: [
93+
{ version: null,
94+
title: 'unreleased',
95+
body: '* foo' },
96+
{ version: 'x.y.z',
97+
title: 'x.y.z - YYYY-MM-DD',
98+
body: '* bar' },
99+
{ version: 'a.b.c',
100+
title: '[a.b.c]',
101+
body: '### Changes\n\n* Update API\n* Fix bug #1' },
102+
{ version: '2.2.3-pre.1',
103+
title: '2.2.3-pre.1 - 2013-02-14',
104+
body: '* Update API' },
105+
{ version: '2.0.0-x.7.z.92',
106+
title: '2.0.0-x.7.z.92 - 2013-02-14',
107+
body: '* bark bark\n* woof\n* arf' },
108+
{ version: '1.3.0',
109+
title: 'v1.3.0',
110+
body: '* make it so' },
111+
{ version: '1.2.3',
112+
title: '[1.2.3](link)',
113+
body: '* init' }
114+
]
115+
}
96116
```
97117

98118
Expects a version to be [semver](http://semver.org/) compliant, otherwise treats it as a plain string.

0 commit comments

Comments
 (0)