Skip to content

Commit

Permalink
Merge pull request #133 from TechnologyAdvice/docs/roadmap
Browse files Browse the repository at this point in the history
Add Roadmap
  • Loading branch information
Josh Habdas committed Dec 21, 2015
2 parents f637369 + b9c124b commit d083889
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,12 @@ npm i stardust -S
## Learn
Check out the [Documentation](https://technologyadvice.github.io/stardust/).

Review our [Component Guidelines]
(https://github.com/TechnologyAdvice/stardust/blob/master/docs/app/Component Guidelines.md).
Before submitting PRs please review our [Component Guidelines]
(https://github.com/TechnologyAdvice/stardust/blob/master/docs/app/Component Guidelines.md) and [Roadmap](https://github.com/TechnologyAdvice/stardust/blob/master/docs/app/ROADMAP.md).


## Getting Started
Hey, we're in development. Minor versions may introduce **breaking changes until v1**.
Hey, we're in development. Minor versions may introduce **breaking changes until the [v1.0** release](https://github.com/TechnologyAdvice/stardust/blob/master/docs/app/ROADMAP.md#v1.0).

### Babel
Stardust is built with ES6 and ES7. Use Babel with the [stage 0](http://babeljs.io/docs/usage/experimental/#enable-by-stage) option to enable these features. We suggest using a [.babelrc](http://babeljs.io/docs/usage/babelrc/) file, which is also picked up by the webpack [babel-loader](https://github.com/babel/babel-loader).
Expand Down Expand Up @@ -56,7 +57,7 @@ module.exports = TryStardust;
### Commands

```
npm run # list npm commands
npm run # list npm commands
gulp help # list gulp commands
```

Expand Down
21 changes: 21 additions & 0 deletions ROADMAP.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
Stardust is a set of themeable React components and usage documentation wrapping the delightful Semantic UI. Our milestones are tracked and managed using GitHub [Milestones and labels](https://guides.github.com/features/issues/#filtering), while the Roadmap presented here is intended to represent a high-level outline of what you can expect in forthcoming major releases.

## Milestones

v1.0

- [ ] Provide licensing information
- [x] Functional [docs website](https://technologyadvice.github.io/stardust) hosted on GitHub Pages (#129)
- [ ] Identify and target a specific version of Semantic UI for the release
- [ ] Implement available Semantic UI `Elements`, `Collections`, `Views` and `Modules`
- [ ] Complete usage documentation for all implemented components
- [ ] Build Tools documentation for use while developing alongside applications
- [ ] Theming documentation and suggested approach
- [ ] Clean-up _Promise_ usage in `Modal` and support isomorphic rendering
- [ ] Provide at least one test for each component and automate test coverage reporting
- [ ] Create annotated StackShare and collaborator chatroom

v2.0

- [ ] Remove jQuery dependency
- [ ] Eliminate use of `className`s for styling and use

0 comments on commit d083889

Please sign in to comment.