Skip to content

Commit

Permalink
Merge pull request #36 from jackmu95/master
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
Pedro Duarte committed Aug 31, 2015
2 parents 953bbf2 + 1f53742 commit b01619c
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 14 deletions.
5 changes: 1 addition & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
**Contributing to wallop**

# Contributing to wallop
wallop is supposed to provide developers the basics and allow them to extend it via the API and Custom Events.
This is the reason why wallop has no Keyboard or Gestures bindings. I would like to keep it this way. 🙏

Expand All @@ -9,7 +8,6 @@ For any new feature please [submit an issue](https://github.com/peduarte/wallop/
Thank you & happy contributing! 👊

## Tests

Please make sure all commits pass the tests `npm run test`.

```bash
Expand All @@ -19,5 +17,4 @@ $ npm run test
Then open this up **http://localhost:9966/__zuul**

## Build

The build task `npm run build` runs the tests and does the minification.
17 changes: 7 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
[![npm version](https://badge.fury.io/js/wallop.svg)](http://badge.fury.io/js/wallop) [![Build Status](https://travis-ci.org/peduarte/wallop.svg)](https://travis-ci.org/peduarte/wallop)
---
# wallop
### Much more than just a slider
[![Build Status](https://travis-ci.org/peduarte/wallop.svg)](https://travis-ci.org/peduarte/wallop) [![npm version](https://badge.fury.io/js/wallop.svg)](http://badge.fury.io/js/wallop)

### Much more than just a slider
wallop is a minimal 4kb library for showing & hiding things.

>❗️️**Important note**️<br>
> ❗️**Important note**️<br>
> Version 1 of *WallopSlider* is not compatible with version 2+.<br>
> If you are still v1, please note that I am no longer supporting it. Documentation, etc has been moved to [this branch](https://github.com/peduarte/wallop/tree/v1).
Expand Down Expand Up @@ -33,7 +32,6 @@ I've created a collection on **[Codepen](http://codepen.io/collection/DQWmxZ/)**
- 4KB minified
- Dependency free


## Install
With npm

Expand All @@ -50,7 +48,6 @@ $ bower install wallop
Download<br>
You can download the latest or checkout all the releases [from this page](https://github.com/peduarte/wallop/releases)


## Usage
Once you have downloaded Wallop, the first thing you need to do is include the CSS and the JavaScript.

Expand Down Expand Up @@ -127,8 +124,8 @@ Here's a list of the available animation modifiers ready for you to use
- `Wallop--fold`
- `Wallop--vertical-slide`

>**protip**<br>
>These animation helpers are especially helpful using if you are using wallop as a slider, but don't feel forced to use them, instead, feel free to take advantage of the classes wallop provides you with, and create you own! Like [these guys](http://london-housing.uk) did.
> **protip**<br>
> These animation helpers are especially helpful using if you are using wallop as a slider, but don't feel forced to use them, instead, feel free to take advantage of the classes wallop provides you with, and create you own! Like [these guys](http://london-housing.uk) did.
## Options
Here's a list of options you can pass to Wallop
Expand All @@ -154,8 +151,8 @@ var Wallop = new Wallop(slider);
// Go to 2nd slide
Wallop.goTo(1);
```
>**#protip**<br>
>index starts at 0 👌
> **#protip**<br>
> index starts at 0 👌
### next
This allows you to go to the next slide
Expand Down

0 comments on commit b01619c

Please sign in to comment.