diff --git a/README.md b/README.md index 672b451..c1cacc5 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,78 @@ -# FFNM -Front-End for the next master +# FFNM (Front-End for the next master) + +Simple plugin to avoid writing Javascript in trivial tasks. + +--- + +## Spanish/Español + +### Instalar + +Añade a tu `` la siguiente etiqueta. + +```html + +``` + +### Ejemplos de uso + +#### Clic + +##### Añadir la clase `show` al selector `#menu` cuando sea pulsado el botón. + +```html + +``` + +##### Quitar la clase `show` al selector `#menu` cuando sea pulsado el botón. + +```html + +``` + +##### Intercambiar la clase `show` al selector `#menu` cuando sea pulsado el botón. + +```html + +``` +#### Scroll + +##### Añadir la clase `down` al `nav` cuando el usuario haga scroll hacia abajo. + +```html + +``` + +##### Quitar la clase `down` al `nav` cuando el usuario haga scroll hacia arriba. + +```html + +``` + +#### Hover + +##### Añadir la clase `tadam` al selector `#menu` cuando el usuario haga `hover` sobre el botón. + +```html + +``` + +#### Clases sin eventos + +##### Añadir la clase `show` al selector `#menu` + +```javascript +class:add('show', '#menu') +``` + +##### Quitar la clase `show` al selector `#menu` + +```javascript +class:remove('show', '#menu') +``` + +##### Intercambiar la clase `show` al selector `#menu` + +```javascript +class:toggle('show', '#menu') +```