Skip to content

Commit 2c67145

Browse files
committed
more doc updates
1.0.0 is now feature complete :During
1 parent e6bb3fb commit 2c67145

File tree

3 files changed

+18
-6
lines changed

3 files changed

+18
-6
lines changed

Readme.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -57,4 +57,4 @@ Guide to Creating Apps with Components:
5757
- [Guide](https://github.com/component/guide)
5858
- [Specifications](https://github.com/component/spec)
5959

60-
[component]: https://github.com/component/component
60+
[component]: https://github.com/component/component

changelogs/1.0.0.md

+14-5
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,6 @@ We don't want to bloat `component(1)` with options, commands, and features.
1616

1717
For more specific changes, please read the [History.md](https://github.com/component/component/blob/master/History.md).
1818

19-
_Please note that the changes described below will be included in the 1.0.0 release, but some may not be
20-
implemented yet in the release candidates. 2 April 2014_
21-
2219
## What's New
2320

2421
### Github Authentication
@@ -51,6 +48,7 @@ So Component has added a few commands to make pinning dependencies and updating
5148
- `component pin` - pin all your dependencies that users semver ranges to a single version.
5249
- `component outdated` - check whether any of your pinned dependencies are outdated.
5350
- `component update` - update all your pinned dependencies to the latest version.
51+
- `component duplicates` - list any duplicates of dependencies and their dependents
5452

5553
Note that these commands only update the `component.json` files.
5654
To actually install these new versions,
@@ -71,8 +69,11 @@ Users can now search for your component using `component search` or at http://co
7169

7270
Component v1 now supports ES6 modules by default.
7371
Simply write an ES6 module with node-like module references, and your app should still work.
74-
Note that CommonJS and ES6 modules are not completely compatible, so you may run into compatibility issues.
75-
However, please let us know if you find any issues!
72+
73+
Note that CommonJS and ES6 modules are not completely compatible, ES6 modules aren't standardized yet, and ES6 to CommonJS transpilers are thus not yet stable.
74+
Thus, you may run into issues.
75+
Please let us know if you find any issues!
76+
The relevant repository is: http://github.com/component/builder-es6-module-to-cjs.
7677

7778
### Smarter `require()`s
7879

@@ -82,6 +83,14 @@ However, this has been a pain as components are generally named with `npm`'s nam
8283
The solution now is to use `require(<user>-<repo>)` in your components, then publish the component to `npm` as `<user>-<repo>`.
8384
No more aliasing hackery will be required on the `browserify` and `node` side.
8485

86+
### Watcher
87+
88+
Component now has a `component build --watch` option, allowing incremental builds. It uses [sane](http://github.com/amasad/sane) under the hood, which seems to be one of the best JS watcher libraries currently published.
89+
90+
### Linking
91+
92+
You may now link local components as version dependencies in your app using the `component link ../path/to/folder` command.
93+
8594
### Glob Support
8695

8796
Many people complained about having to list every single file in a `component.json` manually.

component/faq.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
2+
> Please note that this FAQ is a little out of date and was written before 1.0.0.
3+
14
## Why components?
25

36
Client-side development currently suffers from a lack of structure, more importantly this lack of structure and fundamental sharing of assets makes it difficult to abstract libraries into smaller subsets. Normally you would think twice about separating your library into several parts, because telling end-users to install several pieces is tedious, error-prone, and frankly annoying. Component makes this extremely easy, and we may all benefit from creating smaller lego-blocks for the web.

0 commit comments

Comments
 (0)