Skip to content

Commit 1966650

Browse files
committed
chore: improve README
1 parent 2e0a37d commit 1966650

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ generic features for the whole catalog of resources at once.
1212
This is very useful to scale big projects codebases in order to implement
1313
generic features for the whole catalog or resources.
1414

15-
It uses few basic concepts to construct this registry:
15+
Resource Registry defines a few basic concepts to build this catalog.
1616

17-
## Anatomy of a resource, `ResourceRegistry::Resource`
17+
### Anatomy of a resource, `ResourceRegistry::Resource`
1818

19-
A resource represents the centric part of this library. They should contain and
20-
provide all the necessary information to generate features around. This
21-
includes Capabilities, Repository, verbs and Entity/DTOs schemas.
19+
Resource represent the central part of this library. They should contain and
20+
provide all the necessary information to generate features. This includes
21+
Capabilities, Repository, verbs and Entity/DTOs schemas.
2222

2323
An example of a resource:
2424

@@ -66,7 +66,7 @@ ResourceRegistry::Resource.new(
6666
)
6767
```
6868

69-
## The registry itself, `ResourceRegistry::Registry`
69+
### The registry itself, `ResourceRegistry::Registry`
7070

7171
Gives you access to the whole library using the following API:
7272

@@ -80,7 +80,7 @@ registry.fetch(:employees)
8080
registry.fetch_rall
8181
```
8282

83-
## What brings this gem to the table?
83+
## What does this gem bring to the table?
8484

8585
- Schema registry for resources, maybe we can infere them from entities
8686
- Relate events to resources actions (CRUD and not CRUD)

0 commit comments

Comments
 (0)