Skip to content

Commit

Permalink
chore: improve README
Browse files Browse the repository at this point in the history
  • Loading branch information
jacobobq committed Nov 19, 2024
1 parent 2e0a37d commit 1966650
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 @@ -12,13 +12,13 @@ generic features for the whole catalog of resources at once.
This is very useful to scale big projects codebases in order to implement
generic features for the whole catalog or resources.

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

## Anatomy of a resource, `ResourceRegistry::Resource`
### Anatomy of a resource, `ResourceRegistry::Resource`

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

An example of a resource:

Expand Down Expand Up @@ -66,7 +66,7 @@ ResourceRegistry::Resource.new(
)
```

## The registry itself, `ResourceRegistry::Registry`
### The registry itself, `ResourceRegistry::Registry`

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

Expand All @@ -80,7 +80,7 @@ registry.fetch(:employees)
registry.fetch_rall
```

## What brings this gem to the table?
## What does this gem bring to the table?

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

0 comments on commit 1966650

Please sign in to comment.