Skip to content
This repository has been archived by the owner on Mar 27, 2019. It is now read-only.

Commit

Permalink
add search docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tj committed Sep 19, 2012
1 parent b107ed3 commit 4a8ab92
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions Readme.md
Expand Up @@ -32,6 +32,30 @@ $ component install component/tip
complete : component/tip
```

## Searching for components

By adding your component to the [Components List](https://github.com/component/component/wiki/Components) wiki page it will become automatically available to `component-search(1)`. When invoked with no query all components are displayed, otherwise a filtered search, ordered by the number of github "stars":

```
$ component search ui
component/dialog
url: https://github.com/component/dialog
desc: Dialog component
★ 12
component/notification
url: https://github.com/component/notification
desc: Notification component
★ 10
component/overlay
url: https://github.com/component/overlay
desc: Overlay component
★ 7
```

## Usage

Via `--help`:
Expand Down

0 comments on commit 4a8ab92

Please sign in to comment.