sfc-utils 1.2.5 → 1.2.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +23 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -22,24 +22,44 @@ googleAuth(project, null, true)
|
|
|
22
22
|
`specialnav.js` is a cool variant of `nav.js` that gives it a floating style for special projects, but works the same way.
|
|
23
23
|
|
|
24
24
|
## Install
|
|
25
|
+
|
|
26
|
+
This package is now officially in the npm registry! Hopefully that means no more old versions being installed from the cache. You can install the latest like this:
|
|
27
|
+
|
|
25
28
|
```
|
|
26
|
-
npm i
|
|
29
|
+
npm i sfc-utils
|
|
27
30
|
```
|
|
28
31
|
|
|
32
|
+
You can still install what's on master by running `npm i git+https://github.com/sfchronicle/utils.git` but it will occasionally result in version problems.
|
|
33
|
+
|
|
34
|
+
## Updating utils
|
|
35
|
+
|
|
36
|
+
Ask Evan for the npm credentials for publishing. Once you have them, these are the steps:
|
|
37
|
+
|
|
38
|
+
1. Make sure you've incremented the version number in package.json.
|
|
39
|
+
|
|
40
|
+
1. Update the master branch with changes you want to push.
|
|
41
|
+
|
|
42
|
+
1. Log in to npm via the terminal with `npm login`.
|
|
43
|
+
|
|
44
|
+
1. Run `npm publish`.
|
|
45
|
+
|
|
46
|
+
|
|
29
47
|
## Import the functions
|
|
30
48
|
|
|
31
49
|
```
|
|
32
|
-
import { blendHDN, getSettings
|
|
50
|
+
import { blendHDN, getSettings } from 'sfc-utils'
|
|
33
51
|
```
|
|
34
52
|
|
|
35
53
|
## Use them
|
|
36
54
|
|
|
37
55
|
```
|
|
38
|
-
let
|
|
56
|
+
let settings = getSettings()
|
|
39
57
|
```
|
|
40
58
|
|
|
41
59
|
## Troubleshooting
|
|
42
60
|
|
|
61
|
+
Only an issue for the package installed directly from Github:
|
|
62
|
+
|
|
43
63
|
If you get a message about a new function not existing in your project, you might need to force a reinstall of this package. The best way to do that is to completely uninstall it and then reinstall it:
|
|
44
64
|
|
|
45
65
|
```
|