Skip to content

Commit 4b2deb9

Browse files
committed
update readme with new compat version and changes
1 parent 9964f0b commit 4b2deb9

File tree

1 file changed

+5
-15
lines changed

1 file changed

+5
-15
lines changed

README.md

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,34 +6,24 @@ Spec Dependencies is [SourceJS](http://sourcejs.com) plugin for adding crosslink
66

77
![image](http://monosnap.com/image/gG9KatayyGGg5BxYt3704OIIQHUg0V.png)
88

9-
Compatible with SourceJS v0.4.x-0.5.x (not compatible with SourceJS installed as NPM dep).
9+
Compatible with SourceJS 0.6.x. For older versions use `0.1.x` branch.
1010

1111
## Install
1212

13-
To install, run npm in `sourcejs/user` folder:
13+
To install, run npm in SourceJS project folder:
1414

1515
```
1616
npm install sourcejs-spec-dependencies --save
1717
```
1818

19-
Then run Grunt update in SourceJS root:
20-
21-
```
22-
grunt update
23-
```
24-
25-
or from 0.5.2+
26-
27-
```
28-
npm run build
29-
```
19+
Restart the app, and you're ready to go.
3020

3121

3222
## How to use
3323

3424
### Configuration
3525

36-
By default plugin will parse documentation pages located in `user/specs` folder, to extend the search folder list, update plugin options in `user/options.js`:
26+
By default plugin will parse documentation pages located in `/specs` folder, to extend the search folder list, update plugin options in `/options.js`:
3727

3828
```
3929
{
@@ -45,7 +35,7 @@ By default plugin will parse documentation pages located in `user/specs` folder,
4535
}
4636
```
4737

48-
This conf will ensure that plugin checks both `user/specs` and `user/more-specs` folders to build the dependency tree.
38+
This conf will ensure that plugin checks both `/specs` and `/more-specs` folders to build the dependency tree.
4939

5040

5141
### Manually set spec dependencies

0 commit comments

Comments
 (0)