Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
chivchila committed Sep 2, 2021
1 parent c7f0b21 commit 72d6f3d
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 1 deletion.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@ $ cd n-syndication
$ make install
```

For npm install only (only needed if your project isn't using bower) run
```sh
$ node ./scripts/fromBowerToNpm.js
$ npm install
```

Run the (incomplete) test suite with

```sh
Expand All @@ -26,6 +32,13 @@ Verify that the Sass can compile by running
$ npx sass ./test/main.scss --load-path=./bower_components/
```

For npm install only:
Verify that the Sass can compile by running

```sh
$ npx sass ./test/main.scss --load-path=./node_modules --load-path=./node_modules/@financial-times
```

### Developing with a next app

Instruction for developing the library within a next app will be are in development ([ACC-1156](https://financialtimes.atlassian.net/browse/ACC-1156)).
Expand Down
2 changes: 1 addition & 1 deletion src/js/modal-download.js
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
'use strict';

import {broadcast} from 'n-ui-foundations';
import oViewport from 'o-viewport';
import Superstore from 'superstore';

import {TRACKING} from './config';

import {toElement} from './util';
import {getAllItemsForID, getItemByHTMLElement} from './data-store';
import {getMessage, getAdditionalMessages } from './messages';
import oViewport from 'o-viewport';

const MAX_LOCAL_FORMAT_TIME_MS = 300000;
const localStore = new Superstore('local', 'syndication');
Expand Down
1 change: 1 addition & 0 deletions webpack.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ const extractOptions = [{
sourcemap: true,
includePaths: [
path.resolve('./bower_components'),
path.resolve('./node_modules'),
path.resolve('./node_modules/@financial-times')
],
// NOTE: This line is important for preservation of comments needed by the css-extract-block plugin
Expand Down

0 comments on commit 72d6f3d

Please sign in to comment.