Skip to content
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

Jump to bottom

Update the README #15

Closed
TylorS opened this issue Dec 9, 2015 · 0 comments
Closed

Update the README #15

TylorS opened this issue Dec 9, 2015 · 0 comments
Assignees
@TylorS
Labels
type: docs
Milestone
Release v1.0.0

Comments

@TylorS
Copy link
Member

TylorS commented Dec 9, 2015

Overview

The README is currently lacking any information for the user.
It should include at least

  • Libraries used
  • Differences from Cycle-DOM
  • Simple Example
  • API
  • Travis-CI badge
@TylorS TylorS added this to the Release v1.0.0 milestone Dec 9, 2015
@TylorS TylorS self-assigned this Dec 9, 2015
TylorS added a commit that referenced this issue Dec 9, 2015
@TylorS
docs(README): add useful information
3ebc229 
Add Travis-CI badge
Show how it can be installed via npm
Information on libraries which are used and exported.
Highlight the key differences between Motorcycle-DOM and Cycle-DOM
Add a basic usage example to show how it's imported and expected
to be used in a Motorcycle application.
Add information on API with links to exported variables respective
documentation.

Closes #15
@TylorS TylorS mentioned this issue Dec 9, 2015
Merged
@TylorS TylorS added ~in progress and removed ~ready labels Dec 9, 2015
TylorS added a commit that referenced this issue Dec 9, 2015
@TylorS
docs(README): various fixes
c0805c1 
Proper usage of English. Thanks @Frikki
Removes unnecessary lines

Closes #15
Frikki referenced this issue Dec 10, 2015
@Frikki
Merge branch 'docs/issue-#15' into develop
047383d
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@TylorS TylorS

Labels
type: docs
Projects
None yet
Milestone
Release v1.0.0
Development

No branches or pull requests
2 participants
@Frikki @TylorS