Skip to content

Commit

Permalink
Add README
Browse files Browse the repository at this point in the history
  • Loading branch information
bluefirex committed Jun 2, 2016
1 parent a05a9b0 commit e6ddd99
Showing 1 changed file with 54 additions and 0 deletions.
54 changes: 54 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# SweetDropdown

Versatile dropdowns for any occasion.

![Some variants](http://bfx.re/gLFo/sweetDropdown-overview.png)

## Usage

Install SweetDropdown through bower **or** npm:

npm install sweet-dropdown
bower install sweet-dropdown

You can also install it manually by [downloading a release archive](https://github.com/adeptoas/sweet-dropdown/releases).

Reference these files in your HTML:

```html
<link rel="stylesheet" href="path/to/sweetmodal/dist/min/jquery.sweet-dropdown.min.css" />
<script src="path/to/sweetmodal/dist/min/jquery.sweet-dropdown.min.js"></script>
```

## Examples

For examples, refer to [the demo page](http://sweet-dropdown.adepto.as).

## Browser compatibility

SweetModal should work in most major browsers:

- IE11
- Safari 6+
- Firefox 4+
- Chrome 20+
- Opera 15+
- Microsoft Edge

## Contribution

1. Fork the repository
2. Install `grunt-cli` and `coffee-script` globally via npm
3. Run `node server` and `grunt watch` in two separate terminal tabs while developing. You can reach the example site for development at `http://localhost:5000`
4. When you're done, run one final `grunt` command and commit your work for a pull request.

### Guidelines

- tabs for indentation, 1 tab = 4 spaces
- no inline JavaScript in CoffeeScript files
- camelCase function names
- _camelCase for private functions
- no curly brackets for objects
- always brackets around function calls, except typeof and parse*-functions
- document your functions!

0 comments on commit e6ddd99

Please sign in to comment.