Skip to content

Commit 920c6ce

Browse files
committed
Merge pull request #66 from shanel262/master
Updated readme to show data emitted
2 parents c977549 + aeed8d1 commit 920c6ce

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,20 @@ Contains the response of an earlier call to `role:info,req:part`.
112112
seneca.add('role:info,res:part', (msg, done) => {})
113113
```
114114

115+
## Data Emitted
116+
- name - Name of the module
117+
- user - The User or Organisation that owns the repository
118+
- repo - The repository name
119+
- stars - Number of stars
120+
- forks - Number of forks
121+
- watches - Numbers of watchers
122+
- last - The last commit to the repository
123+
- urlRepo - A link to the repository
124+
- urlClone - A clone URL
125+
- urlSsh - An SSH URL
126+
- pullRequests - Open pull requests
127+
- cached - The time the data was last cached at
128+
115129
## Contributing
116130
The [NodeZoo org][] encourages __open__ and __safe__ participation.
117131

0 commit comments

Comments
 (0)