Skip to content

Updated readme to show data emitted #66

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 18, 2016
Merged

Updated readme to show data emitted #66

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,20 @@ Contains the response of an earlier call to `role:info,req:part`.
seneca.add('role:info,res:part', (msg, done) => {})
```

## Data Emitted
- name - Name of the module
- user - The User or Organisation that owns the repository
- repo - The repository name
- stars - Number of stars
- forks - Number of forks
- watches - Numbers of watchers
- last - The last commit to the repository
- urlRepo - A link to the repository
- urlClone - A clone URL
- urlSsh - An SSH URL
- pullRequests - Open pull requests
- cached - The time the data was last cached at

## Contributing
The [NodeZoo org][] encourages __open__ and __safe__ participation.

Expand Down