Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

add search docs

  • Loading branch information...
commit 4a8ab9273978db4838f42d2d9c71dbc7ab7e4474 1 parent b107ed3
@tj tj authored
Showing with 24 additions and 0 deletions.
  1. +24 −0 Readme.md
View
24 Readme.md
@@ -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`:
Please sign in to comment.
Something went wrong with that request. Please try again.