Skip to content

Commit a2233a3

Browse files
authored
update the readme for new features (#86)
1 parent be23668 commit a2233a3

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

README.md

+15-3
Original file line numberDiff line numberDiff line change
@@ -79,8 +79,8 @@ A new package can be created using `psc-package init`. This will:
7979

8080
To add a dependency, either:
8181

82-
- Use the `install` command, which will update the project configuration automatically, or
83-
- Modify the `psc-package.json` file, and sync manually by running the `update` command.
82+
- Use the `install <package name>` command, which will update the project configuration automatically, or
83+
- Modify the `psc-package.json` file, and sync manually by running the `install` command (previously `update`).
8484

8585
### Build a project
8686

@@ -128,12 +128,24 @@ Then copy over `packages.json` into the directory:
128128

129129
If this builds correctly, you can then push up this branch and make a pull request. Travis will verify your package builds correctly, and then we will try to merge your pull request. Your package will then be available in the next tagged package set.
130130

131+
### Formatting the package set
132+
133+
When creating your pull request, make sure to run the `format` command to pretty-print the packages file. This helps us avoid problems in the future with git diffs and so on.
134+
131135
### Update a package in the set
132136

133137
Similar to the above, you will need to do the setup. You can then modify the version field to the version you wish to use. Once you have updated the package set, run the copy command and verify the package you have modified.
134138

135139
Then you can make a pull request. Again, once Travis verifies your change, we will merge it into `master` and your change will be available in the next tag.
136140

141+
### Add a package from Bower
142+
143+
If you have Bower installed on your system, you can easily add a package from Bower to the package set. Use the Bower package name to add the package using the `add-from-bower` command:
144+
145+
```
146+
psc-package add-from-bower <purescript-something>
147+
```
148+
137149
## FAQ
138150

139151
### Can I add a dependency which is not in the package set?
@@ -152,5 +164,5 @@ clear the cache for the changes to take effect.
152164

153165
```
154166
$ rm -rf .psc-package
155-
$ psc-package update
167+
$ psc-package install
156168
```

0 commit comments

Comments
 (0)