Skip to content

Commit

Permalink
Add LICENSE and README
Browse files Browse the repository at this point in the history
  • Loading branch information
nathankot committed May 24, 2016
0 parents commit da22bf0
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 0 deletions.
7 changes: 7 additions & 0 deletions LICENSE
@@ -0,0 +1,7 @@
Copyright (c) 2016 Nathan Kot

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
34 changes: 34 additions & 0 deletions README
@@ -0,0 +1,34 @@
# counsel-dash

Browse [Dash](http://www.kapeli.com/dash) docsets using [Ivy](https://github.com/abo-abo/swiper).

## Installation

### MELPA

Pending.

### Source

Make sure `counsel-dash.el` is in your `load-path` and then:

```elisp
(require 'counsel-dash)
```

## How it works

This is a simple wrapper around [helm-dash](https://github.com/areina/helm-dash/), of which you should check out for
implementation details.

Unfortunately [helm-dash](https://github.com/areina/helm-dash/) depends on helm, so this package also implicitly depends
on helm - even though helm isn't really necessary. In the future, helm-dash may be decoupled into a separate library
that provides dash capabilities only. At that point we will switch over to the new library - the API will remain unchanged.

## Configuration



## License

See [LICENSE](https://github.com/nathankot/counsel-dash/blob/master/LICENSE)

0 comments on commit da22bf0

Please sign in to comment.