Skip to content
This repository was archived by the owner on Dec 11, 2020. It is now read-only.

Commit e4d4ece

Browse files
committed
update readme
1 parent 5ea3e57 commit e4d4ece

File tree

1 file changed

+6
-16
lines changed

1 file changed

+6
-16
lines changed

readme.md

Lines changed: 6 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ call `lucid`:
3737
export PATH="./vendor/bin:$PATH"
3838
```
3939

40-
For a list of all the commands that are available run `lucid` or see the [CLI Reference](#cli-reference).
40+
For a list of all the commands that are available run `lucid` or see the [CLI Reference](https://github.com/lucid-architecture/laravel-console).
4141

4242
#### Launching the Interactive Console (UI)
4343

@@ -87,7 +87,7 @@ One more step is required for Laravel to recognise the service we just created.
8787

8888
##### CLI
8989
```
90-
lucid make:feature api ListUsers
90+
lucid make:feature ListUsers api
9191
```
9292

9393
##### UI
@@ -100,7 +100,7 @@ This project ships with a couple of jobs that can be found in their correspondin
100100

101101
##### CLI
102102
```
103-
lucid make:job user GetUsers
103+
lucid make:job GetUsers user
104104
```
105105

106106
##### UI
@@ -136,15 +136,15 @@ public function handle(Request $request)
136136
```
137137

138138
The `RespondWithJsonJob` is one of the Jobs that were shipped with this project, it lives in the `Http` domain and is
139-
used to respond to a request in JSON format.
139+
used to respond to a request in structured JSON format.
140140

141-
##### Expose The Feature
141+
##### Serve The Feature
142142
To be able to serve that Feature we need to create a route and a controller that does so.
143143

144144
Generate a plain controller with the following command
145145

146146
```
147-
lucid make:controller api user --plain
147+
lucid make:controller user api --plain
148148
```
149149

150150
Add the `get` method to it:
@@ -169,13 +169,3 @@ Route::get('/users', 'UserController@get');
169169
```
170170

171171
Now if you visit `/api/users` you should see the JSON structure.
172-
173-
## CLI Reference
174-
Following are the commands available through the `Lucid` CLI.
175-
176-
- `make:service [name]`: Generate a new Service with the given name
177-
- `make:feature [service] [feature title]`: Generate a new Feature in the given Service
178-
- `make:job [domain] [job title]`: Generate a new Job in the specified Domain (non-existing domains will be created)
179-
- `make:controller [service] [controller name]`: Generate a new Controller in the given Service
180-
- `list:services`: List the existing Services
181-
- `list:features`: List the existing Features, organised by Service

0 commit comments

Comments
 (0)