Skip to content
This repository was archived by the owner on Nov 19, 2021. It is now read-only.

Commit

Permalink
Feature: added readme and license files
Browse files Browse the repository at this point in the history
  • Loading branch information
Vadim Kadnikov committed Apr 15, 2015
1 parent 1cee09b commit 136f5c2
Show file tree
Hide file tree
Showing 3 changed files with 64 additions and 2 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2015 Vadim Kadnikov

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.
44 changes: 43 additions & 1 deletion Readme.md
Original file line number Diff line number Diff line change
@@ -1 +1,43 @@
**It's not ready for production yet :(**
AngularJS Emoji Picker
======================

AngularJS Emoji Picker is a simple emoji picker for your web forms. This project heavily inspired by
[Angular Emoji](https://github.com/Coraza/angular-emoji-popup/), but it does not required external dependencies
like JQuery, etc.

Installation
------------

### Bower

The simplest way to install Emoji Picker is use [Bower](http://bower.io/).

```bash
bower install angular-emoji-picker --save
```

This will install the latest release.

### Manual

You can also just download the contents of the `dist/` folder and add dependencies manually.

### Module loading
Don't forget to load the `vkEmojiPicker` module or nothing will happen.

```javascript
angular.module('myModule', ['vkEmojiPicker']);
```

Known issues and limitations
----------------------------
**It's not ready for production yet :)**

Contributing
------------

1. Fork it ( https://github.com/terranisu/angular-emoji-picker/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
1 change: 0 additions & 1 deletion bower.json
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,6 @@
"**/.*",
"node_modules",
"bower_components",
"test",
"tests"
],
"resolutions": {
Expand Down

0 comments on commit 136f5c2

Please sign in to comment.