Skip to content
Permalink
Browse files

clean up docs and global npm scripts

  • Loading branch information...
nickforddesign committed Jul 10, 2019
1 parent ff24493 commit 5942fd264e13e5e1252d86d30e3be38516910a21
@@ -39,7 +39,7 @@ For the curious, we are able to pause animated gifs by writing their data to a c
## Contributing

- Fork or clone the repository.
- Install lerna
- Install lerna globally (optional)

```bash
npm install -g lerna
@@ -54,7 +54,7 @@ npm install
- Install the sub-package dependencies

```bash
lerna bootstrap --hoist
npm run bootstrap
```

- Run tests for all sub-packages
@@ -63,6 +63,12 @@ lerna bootstrap --hoist
npm test
```

- Run build for all sub-packages

```bash
npm run build
```

- If you are part of the ctrl-freaks organization, you can publish directly to npm:

```bash

Some generated files are not rendered by default. Learn more.

@@ -1,8 +1,9 @@
{
"name": "freezeframe-root",
"scripts": {
"bootstrap": "lerna bootstrap",
"bootstrap": "lerna bootstrap --hoist",
"test": "lerna run test --stream",
"build": "lerna run build --stream",
"lint": "eslint ./"
},
"devDependencies": {
@@ -55,5 +55,9 @@
"bugs": {
"url": "https://github.com/Ctrl-Freaks/freezeframe.js/issues"
},
"homepage": "https://github.com/Ctrl-Freaks/freezeframe.js#readme"
"homepage": "https://github.com/Ctrl-Freaks/freezeframe.js#readme",
"keywords": [
"freezeframe",
"gif"
]
}
@@ -98,7 +98,7 @@ You can also pass gifs as children, they will all inherit the any options passed

### Options

The `options` prop accepts all options allowed by [freezeframe core](../freezeframe)
The `options` prop accepts all options allowed by [freezeframe core](../freezeframe#options)

```jsx
<ReactFreezeframe
@@ -56,21 +56,6 @@ export default {
</script>
```

## Options

The `options` prop accepts all options allowed by [freezeframe core](../freezeframe)

```html
<template>
<vue-freezeframe
src="./something.gif"
:options="{
trigger: false
}"
/>
</template>
```

## Slot

Using the default slot, you can freeze any .gifs inside, while safely including other content too.
@@ -92,6 +77,21 @@ Using the default slot, you can freeze any .gifs inside, while safely including
</template>
```

## Options

The `options` prop accepts all options allowed by [freezeframe core](../freezeframe#options)

```html
<template>
<vue-freezeframe
src="./something.gif"
:options="{
trigger: false
}"
/>
</template>
```

## Events

All freezeframe events are emitted from the freezeframe component:

0 comments on commit 5942fd2

Please sign in to comment.
You can’t perform that action at this time.