Skip to content

Commit fd4708b

Browse files
committed
Fix spelling and some out of date docs
1 parent 17caaf4 commit fd4708b

File tree

1 file changed

+26
-11
lines changed

1 file changed

+26
-11
lines changed

readme.md

Lines changed: 26 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,10 @@ and continue on. There is no special configuration needed in any project.
2020
## Setup
2121

2222
Grab the phar archive and copy it to `/usr/local/bin` or add it to your path.
23-
Symlink the phar to `spm` or a.n.other name.
23+
Symlink the phar to `spm` or a.n.other name. Be sure to verify the SHA checksum with
24+
the ones in the release checksums text file.
2425

25-
Run: `spm init` to create the standard configurtion (see later).
26+
Run: `spm init` to create the standard configuration (see later).
2627

2728
Or:
2829

@@ -39,8 +40,8 @@ verify the SHA384 hash and copy the phar to `/usr/local/bin`, then symlink it to
3940
set up with verbose output.
4041

4142
```bash
42-
curl --silent --fail --location --retry 3 --output /tmp/somnambulist-project-manager.phar --url https://github.com/dave-redfern/somnambulist-project-manager/releases/download/0.3.0/somnambulist-project-manager.phar \
43-
&& echo "7a51d920a9ae6bc77eb8229ef4ebee78f5522c2a7344bee876c9ae9626f3f1acd903bd386740ff9ed8bd5cb3113ebe01 /tmp/somnambulist-project-manager.phar" | shasum -a 384 -c \
43+
curl --silent --fail --location --retry 3 --output /tmp/somnambulist-project-manager.phar --url https://github.com/dave-redfern/somnambulist-project-manager/releases/download/0.5.4/somnambulist-project-manager.phar \
44+
&& echo "647d442b0297963b3fc334f80fad49f0626564d36b52e97acb0b42fd40c47c883e7054ab739658154316505b7cb9064c /tmp/somnambulist-project-manager.phar" | shasum -a 384 -c \
4445
&& mv -v /tmp/somnambulist-project-manager /usr/local/bin/somnambulist-project-manager.phar \
4546
&& chmod -v 755 /usr/local/bin/somnambulist-project-manager.phar \
4647
&& ln -vf -s /usr/local/bin/somnambulist-project-manager.phar /usr/local/bin/spm \
@@ -249,7 +250,7 @@ services templates are pre-configured globally:
249250

250251
* data - [Data Service](https://github.com/dave-redfern/data-service-skeleton)
251252
* service - [Symfony Micro Service](https://github.com/dave-redfern/micro-service-skeleton)
252-
* web - [Symfony Skeletong](https://github.com/symfony/skeleton)
253+
* web - [Symfony Skeleton](https://github.com/symfony/skeleton)
253254

254255
Templates are grouped by type: `library` and `service`. Only library types are displayed when
255256
making new libraries, and the same goes for services.
@@ -325,13 +326,27 @@ and dirname values.
325326
By default when using `project:create`, `libraries:create` or `services:create` a git repository
326327
is started, but no remote is set. You can set this after the fact by using:
327328

328-
* config:<x>:repository
329-
330-
where X is project/library/service. This will either add or update the origin URL in the git
331-
repo.
329+
```shell script
330+
spm config git:remote <project_name> <repo>
331+
```
332+
333+
Several other config options can be changed using the `config` command:
334+
335+
* docker:name
336+
* docker:network
337+
* git:remote
338+
* service:container:name
339+
* service:dependency:add
340+
* service:dependency:remove
341+
* template:add
342+
* template:remove
343+
344+
If the option is not provided it will be prompted for; similarly if the project name is not
345+
specified, the current list of projects will be presented.
332346

333-
__Note:__ this command will only operate on origin. If you used a different name, then you
334-
must manually set this and manually update the project config file.
347+
__Note:__ when changing the remote repository, only a remote named `origin` will be modified.
348+
If you used a different name, you must manually change the remote and update the project config
349+
file yourself.
335350

336351
### Customising the development environment
337352

0 commit comments

Comments
 (0)