Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create es-module bundle #43

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Create es-module bundle #43

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fefbfeb
add es-module build, update rollup, declare es-module in package.json
timrosskamp Jun 19, 2018
5e8ab87
add usage explanation of es-module in README.md
timrosskamp Jun 19, 2018
d5f1ddf
Merge pull request #1 from timrosskamp/feat/es-module
timrosskamp Jun 20, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 18 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,21 @@ bower install macy
```

## Usage

Manually [Download](https://github.com/bigbitecreative/macy.js/archive/master.zip) the script and link `dist/macy.js` in your HTML:

```html
<script src="macy.js"></script>
```

Or Import ES Module in a module bundler:

```javascript
import Macy from 'macy';
```

Now you can start using Macy:

```javascript
var macyInstance = Macy({
// See below for all available options.
Expand Down Expand Up @@ -69,7 +84,7 @@ Set this to true if you would prefer to use a different image loaded library.
#### **mobileFirst**
*Default: `false`*

Setting this value to true will alter how the breakAt options will work. Macy will now work in a mobile first way so the default `columns` will be the default then if for example you have `400: 2` in your breakAt object, if the document is greater or equal to 400px the column count will be 2.
Setting this value to true will alter how the breakAt options will work. Macy will now work in a mobile first way so the default `columns` will be the default then if for example you have `400: 2` in your breakAt object, if the document is greater or equal to 400px the column count will be 2.

#### **breakAt**

Expand All @@ -79,9 +94,9 @@ If the viewport resizes after the page has loaded, Macy will rerun to ensure opt

If the column is set to one then Macy will remove all styling to leave you to style it perfectly on mobile.

Added in v2.1 breakAt now supports changing margin within these breakpoints.
Added in v2.1 breakAt now supports changing margin within these breakpoints.

For example
For example

```
{
Expand Down
Loading