Skip to content

Commit

Permalink
Updated readme with npm install
Browse files Browse the repository at this point in the history
  • Loading branch information
agorilla authored Dec 16, 2018
1 parent 9a72355 commit c53f2d5
Showing 1 changed file with 18 additions and 24 deletions.
42 changes: 18 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,28 @@
# Original script
https://github.com/elcheio/sass-map-get-next-prev
This repo is a fork of the original source. It only adds the basic requirements that are necessary to enable installation npm.

## Sass map-get functions
# Sass map-get functions

Enhancement functions map-get-next and map-get-prev.
For example when Sass map is used with a `@each` loop.

Thanks to [@rowild](https://github.com/rowild) now available as npm package.

## Table of Contents
- [Installation with npm](#installation-with-npm)
- [map-get-next](#map-get-next)
- [Basic usage](#basic-usage)
- [CSS output](#css-output)
- [Practical usage](#practical-usage)
- [CSS output](#css-output-1)
- [Parameters](#parameters)
- [map-get-prev](#map-get-prev)
- [Basic usage](#basic-usage-1)
- [CSS output](#css-output-2)
- [Parameters](#parameters-1)

## Installation with npm

For usage in node simply add
```json
"sass-map-get-next-prev": "git+https://github.com/rowild/sass-map-get-next-prev.git",
```
to your package.json, then run `npm install`.

## Tutorial on how to use these functions
- [Sass map-get functions](#sass-map-get-functions)
- [Installation with npm](#installation-with-npm)
- [Tutorial on how to use these functions](#tutorial-on-how-to-use-these-functions)
- [map-get-next](#map-get-next)
- [Basic usage](#basic-usage)
- [CSS output](#css-output)
- [Practical usage](#practical-usage)
- [CSS output](#css-output-1)
- [Parameters](#parameters)
- [map-get-prev](#map-get-prev)
- [Basic usage](#basic-usage-1)
- [CSS output](#css-output-2)
- [Parameters](#parameters-1)
npm install sass-map-get-next-prev -D
```

## map-get-next

Expand Down

0 comments on commit c53f2d5

Please sign in to comment.