README.md in marketplace-kit-0.2.0 vs README.md in marketplace-kit-0.2.1
- old
+ new
@@ -13,13 +13,10 @@
1. Go to marketplace folder you are working on
2. Ensure `marketplace_builder` directory exists
3. Create `marketplace_builder/.builder` file with endpoint names and their urls
```
{
- "localhost": {
- "url": "http://marketplace-name.lvh.me:3000"
- },
"staging": {
"url": "https://staging-url.near-me.com"
},
"production": {
"url": "https://production-url.near-me.com"
@@ -28,23 +25,31 @@
```
## Usage
`marketplace-kit <command> [flags]`
-Example:
-`marketplace-kit deploy -f -e staging`
+### Available flags
+| Flag | For command | Description |
+| ----------------- | ------------- | ------ |
+| `-e <endpoint>` | all | Specifies endpoint. Endpoint name is the key inside the `.builder` config file |
+| `-f` / `--force` | deploy | When added to deploy command it will deploy all the files (also those not changed) to specified endpoint |
-## Available commands
+
+### Available commands
All commands should be run in the marketplace directory (ie. `marketplace-nearme/`)
-| Command | Description |
+| Command | Description |
| ----------------- | ------------- |
| `pull` | Pulls files from database and saves them in the filesystem |
-| `deploy` | Updates database using the filesystem as a source |
-| `deploy -e staging` | Deploys to staging environment (-e option is available for all commands) |
-| `deploy -f` | Updates database using the filesystem as a source with force mode enabled (override all files, don't skip not changed) |
-| `sync` | Watches filesystem and updates the database on every change |
+| `sync` | Watches filesystem and updates specified endpoint on every file change inside `marketplace_builder` directory |
+| `deploy` | Updates database using the filesystem as a source. By default this command is trying to send only files that changed since the last deploy |
+### Examples
+`marketplace-kit pull -e qa`
+
+`marketplace-kit sync -e production`
+
+`marketplace-kit deploy -f -e staging`
## Contributing
[Contributing quick start](https://github.com/mdyd-dev/marketplace-kit/blob/master/CONTRIBUTE_README.md)