Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Fixed grammar and commas.
  • Loading branch information
fahurox authored and ramunasd committed Oct 17, 2023
1 parent 1f4765d commit 3dc1e52
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ Satisfy provides:

* a Web UI: A CRUD to manage your satis configuration file
* a simple security layer with a login form
* a webhook endpoints for most popular version control systems
* a webhook endpoints for the most popular version control systems
* Satis itself

Satisfy ease your satis configuration management. It provides simple web UI over Satis to avoid a hand-editing of the satis.json configuration file. All repositories from a composer.lock file can also be imported via upload.
Satisfy ease your satis configuration management. It provides a simple web UI over Satis to avoid a hand-editing of the satis.json configuration file. All repositories from a composer.lock file can also be imported via upload.


## How it works ?
## How it works?

Basically, it just reads/writes the satis.json file and provides a web CRUD.

Expand All @@ -40,7 +40,7 @@ Basically, it just reads/writes the satis.json file and provides a web CRUD.
* or use interactice satis CLI tool `./bin/satis init`
* or submit form at /admin/configuration

By default, the `satis.json` file is expected at the project root, but You can set another path under parameter `satis_filename`.
By default, the `satis.json` file is expected at the project root, but You can set another path under the parameter `satis_filename`.

### Application configuration

Expand All @@ -52,11 +52,11 @@ You can restrict the access setting `admin.auth` parameter (in `app/config/param

## Run Satisfy

Create a webserver pointing to the `public` directory. Browse to »/admin/« to manage the `satis.json`. To serve the `package.json` it is required to run Satis first.
Create a web server pointing to the `public` directory. Browse to »/admin/« to manage the `satis.json`. To serve the `package.json` it is required to run Satis first.

### Satis packages definition generation

Since Satisfy does only manage the Satis configuration file, it is necessary to build the package definitions using Satis.
Since Satisfy does only manages the Satis configuration file, it is necessary to build the package definitions using Satis.

A bin shortcut to Satis is already included in Satisfy, so run the following command to generate the files in the web folder.

Expand All @@ -66,7 +66,7 @@ A bin shortcut to Satis is already included in Satisfy, so run the following com

### Automatically build a single package using WebHooks

For example, you can trigger a package generation for your BitBucket project by setting up a BitBucket webhook to connect back to [your-satis-url]/webhook/bitbucket every time you do a code push. This is more efficient than doing a full build, and avoids you having to run full builds on a frequent schedule, or logging in to the admin interface just to force a build.
For example, you can trigger a package generation for your BitBucket project by setting up a BitBucket webhook to connect back to [your-satis-url]/webhook/bitbucket every time you do a code push. This is more efficient than doing a full build and avoids you having to run full builds on a frequent schedule or logging in to the admin interface just to force a build.

## Authors

Expand Down

0 comments on commit 3dc1e52

Please sign in to comment.