UNPKG

3.71 kBMarkdownView Raw
1 ![web component logo](http://i49.tinypic.com/e7nj9v.png)
2
3 [![Build Status](https://travis-ci.org/componentjs/component.png)](https://travis-ci.org/componentjs/component)
4
5 Component is a vertically integrated frontend solution, handling everything from package management to the build process, handling everything including HTML, JS, CSS, images, and fonts. Think of it as an opinionated `npm + browserify + rework-npm + grunt/gulp/broccoli` all wrapped into `component build`.
6
7 Want to know more about Component? Visit the [guide](https://github.com/componentjs/guide) or view the [comparison with other solutions](https://github.com/componentjs/guide/blob/master/component/vs.md).
8
9 If you're confused about _component_, _components_, _componentjs_, please read [disambiguation](https://github.com/componentjs/component/blob/master/disambiguation.md)
10
11> **Component 1.0.0**: Several
12major new features have been added, some have been removed, and the project has been greatly reorganized. You may need to upgrade your
13version of node and/or npm to avoid breakage. Please see the detailed [changelog](https://github.com/componentjs/guide/blob/master/changelogs/1.0.0.md). Component 0.x will not be maintained anymore.
14
15## Installation
16
17 First, you need [node](http://nodejs.org) v0.10+ installed. If you do not have it installed, visit [node's download page](http://nodejs.org/download/).
18
19 With [node](http://nodejs.org) installed, run the following command:
20
21 $ npm install -g component
22
23## Getting Started
24
25Read this [Getting Started](https://github.com/componentjs/guide/blob/master/component/getting-started.md) guide to get a basic static site running very quickly with Component.
26
27Note: the Component repo (this repo) has only documentation for Component 0.19. All of the documentation related to 1.0.0 will be handled in the [guide repo](https://github.com/componentjs/guide).
28
29## Team
30
31The team and organization have undergone massive changes. In summary, [jonathanong](https://github.com/jonathanong) stopped developing Component and started with [normalize.io](https://normalize.github.io/) and the guys from [segmentio](https://github.com/segmentio) switched to using [duo](http://duojs.org). Component will still be maintained and updated while it is in use. You can read more about Duo.js and Component [here](https://github.com/componentjs/component/blob/master/Extra.md#about-duojs).
32
33The long story of Component and the changes that occurred in component can be found in Jonathan Ong's blog post ["the future of component"](http://www.jongleberry.com/the-future-of-component.html).
34
35Development for component (maintenance and features) will be continued at the latest when latest browsers will support the [ES6 modules](http://guybedford.com/es6-modules-today) and [Web Components](http://www.w3.org/TR/components-intro/) natively.
36
37## Contributors
38
39- [Anton Wilhelm](https://github.com/timaschew)/[@timaschew](https://twitter.com/timaschew) - maintainer
40- [Keith Rosenberg](https://github.com/netpoetica)/[@netpoetica](https://twitter.com/netpoetica) - maintainer
41- [Trevor Gerhardt](https://github.com/trevorgerhardt)/[@trevorgerhardt](https://twitter.com/trevorgerhardt) - maintainer
42- [Clinton Wood](https://github.com/clintwood) - maintainer
43- [Jason Kurht](https://github.com/jasonkuhrt)/[@jasonkuhrt](https://twitter.com/jasonkuhrt) - maintainer
44- [visionmedia](https://github.com/visionmedia)/[@tjholowaychuk](https://twitter.com/tjholowaychuk) - original author
45- [jonathanong](https://github.com/jonathanong)/[@jongleberry](https://twitter.com/jongleberry) - second-gen author
46- [segmentio](https://github.com/segmentio)/[segment.io](https://segment.io) - original sponsor