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

Commit b075b80

Browse files
committed
Typos and grammar fixes
1 parent aa00134 commit b075b80

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

readme.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -153,15 +153,15 @@ the thinnest controllers ever! Here's an example of generating a feature and ser
153153
> You might want to [Setup](#setup) to be able to use the `lucid` command.
154154
155155
> IMPORTANT! You need at least one service to be able to host your features. In this example we are using the Api
156-
service generated previously, refered to as `api` in the commands.
156+
service generated previously, referred to as `api` in the commands.
157157

158158
```
159159
lucid make:feature SearchUsers api
160160
```
161161

162162
And we will have `src/Services/Api/Features/SearchUsersFeature.php` and its test `src/Services/Api/Tests/Features/SearchUsersFeatureTest.php`.
163163

164-
Inside the Feature class there's a `handle` method which is the method that will be called when we dispatch that feature,
164+
Inside the Feature class, there's a `handle` method which is the method that will be called when we dispatch that feature,
165165
and it supports dependency injection, which is the perfect place to define your dependencies.
166166

167167
Now we need a controller to serve that feature:
@@ -348,11 +348,11 @@ Value Objects and anything that has to do with data (algorithms etc.).
348348

349349
## Foundation
350350
This is a place for foundational elements that act as the most abstract classes that do not belong in any of the
351-
components, currenly holds the `ServiceProvider` which is the link between the services and the framework (Laravel).
351+
components, currently holds the `ServiceProvider` which is the link between the services and the framework (Laravel).
352352
You might never need or use this directory for anything else, but in case you encountered a case where a class
353353
needs to be shared across all components and does belong in any, feel free to use this one.
354354

355-
Every service must be registered inside the foundation's service provider after being created for laravel to know about it,
355+
Every service must be registered inside the foundation's service provider after being created for Laravel to know about it,
356356
simply add `$this->app->register([service name]ServiceProvider::class);` to the `register` methods of the
357357
foundation's `ServiceProvider`. For example, with an Api Service:
358358

@@ -368,7 +368,7 @@ public function register()
368368

369369
## Getting Started
370370
This project ships with the [Lucid Console](https://github.com/lucid-architecture/laravel-console) which provides an interactive
371-
user interface and a command line interface that are useful for scaffolding and exploring Services, Features and Jobs.
371+
user interface and a command line interface that are useful for scaffolding and exploring Services, Features, and Jobs.
372372

373373
### Setup
374374
The `lucid` executable will be in `vendor/bin`. If you don't have `./vendor/bin/` as part of your `PATH` you will
@@ -417,7 +417,7 @@ src/Services/Api
417417
└── resources # Assets, Lang and Views
418418
```
419419

420-
One more step is required for Laravel to recognise the service we just created.
420+
One more step is required for Laravel to recognize the service we just created.
421421

422422
#### Register Service
423423

@@ -434,7 +434,7 @@ lucid make:feature ListUsers api
434434

435435
##### UI
436436

437-
Using on of the methods above, the new Feature can be found at `src/Services/Api/Features/ListUsersFeature.php`.
437+
Using one of the methods above, the new Feature can be found at `src/Services/Api/Features/ListUsersFeature.php`.
438438
Now you can fill up a bunch of jobs in its `handle` method.
439439

440440
### 3. Create a Job
@@ -447,7 +447,7 @@ lucid make:job GetUsers user
447447

448448
##### UI
449449

450-
Using on of the methods above, the new Job can be found at `src/Domains/User/Jobs/GetUsers` and now you can fill
450+
Using one of the methods above, the new Job can be found at `src/Domains/User/Jobs/GetUsers` and now you can fill
451451
it with functionality in the `handle` method. For this example we will just add a static `return` statement:
452452

453453
```php
@@ -478,7 +478,7 @@ public function handle(Request $request)
478478
```
479479

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

483483
##### Serve The Feature
484484
To be able to serve that Feature we need to create a route and a controller that does so.
@@ -513,15 +513,15 @@ Route::get('/users', 'UserController@get');
513513
Now if you visit `/api/users` you should see the JSON structure.
514514

515515
## Microservices
516-
If you have been hearing about microservices lately, and wondering how that works and would like plan your next project
516+
If you have been hearing about microservices lately, and wondering how that works and would like to plan your next project
517517
based on microservices, or build your application armed and ready for the shift when it occurs, Lucid is your best bet.
518518
It has been designed with scale at the core and the microservice transition in mind, it is no coincidence that the
519519
different parts of the application that will (most probably) later on become the different services with the microservice
520-
architecture, are called **Service**. However, [it is recommended](http://martinfowler.com/bliki/MonolithFirst.html)
520+
architecture are called **Service**. However, [it is recommended](http://martinfowler.com/bliki/MonolithFirst.html)
521521
that only when your monolith application grow so large that it becomes crucial to use microservices for the sake of
522522
the progression and maintenance of the project, to do the shift; because once you've built your application using Lucid,
523523
the transition to a microservice architecture will be logically simpler to plan and physically straight-forward
524524
to implement. There is a [microservice counterpart](https://github.com/lucid-architecture/laravel-microservice)
525525
to Lucid that you can check out [here](https://github.com/lucid-architecture/laravel-microservice).
526526

527-
With more on the means of transitioning from a monolith to a microservice
527+
With more on the means of transitioning from a monolith to a microservice.

0 commit comments

Comments
 (0)