@elek-io/core 0.6.0 → 0.8.0

package/README.md

@@ -2,26 +2,33 @@
 
 [![codecov](https://codecov.io/gh/elek-io/core/graph/badge.svg?token=GSZIZMVG6Q)](https://codecov.io/gh/elek-io/core)
 
-Handles core functionality of elek.io Projects like file IO and version control.
+Handles core functionality of elek.io Projects like file IO and version control as well as providing schemas and types.
 
 ```
 |-- src
 |   |-- error
 |   |   Different classes extending Error.
+|   |-- schema
+|   |   Zod schemas for validation and types.
 |   |-- service
 |   |   Contains CRUD logic that does file-io as well as utility functions.
 |   |   The methods are mostly used as endpoints
-|   |   so their input is validated against a zod schema.
+|   |   so their input is validated against our zod schemas.
 |   |-- test
-|   |   Additional files only used for testing.
+|   |   Additional files and utility functions only used for testing.
 |   |-- upgrade
 |   |   Files containing logic to upgrade each Project to support a higher Core version.
 |   |   This may include iterating over all Assets to add a new key / value
 |   |   because the new Core version uses it to store additional information.
 |   |-- util
 |   |   Utility functions like path generation.
-|   |-- index.ts
-|   |   Exports ElekIoCore main class which makes the services endpoints accessible.
+|   |-- index.browser.ts
+|   |   Exports all schemas and types as well as the ElekIoCore type
+|   |   but does not export the ElekIoCore main class,
+|   |   since it is not actually usable in a browser environment.
+|   |-- index.node.ts
+|   |   Exports the ElekIoCore main class which makes the services endpoints accessible
+|   |   as well as schemas and utility functions.
 ```
 
 ## The concept behind Projects, Collections, Entries, Values and Assets
@@ -29,6 +36,7 @@ Handles core functionality of elek.io Projects like file IO and version control.
 ```
 |-- Project - e.g. "Website"
 |   |-- Collection - e.g. "Blog"
+|   |   Contains Field definitions all Entries and Values of the Collection must follow.
 |   |   |-- Entry - e.g "Post"
 |   |   |   |-- Value - e.g for a post's title: "Quarterly results 7% higher than expected"
 |   |   |   |-- Asset - a reference to a previously added Asset like image, PDF or ZIP
@@ -41,20 +49,20 @@ Are a container for Collections, Entries, Values and Assets. Think of a folder c
 
 ### Collections
 
-Contains ValueDefinitions (a schema) for possible Values each Entry can or has to have.
-e.g. for a Blog, it could have the following definition for each post / Entry:
+Contains Field definitions (a schema) for possible Values each Entry can or has to have.
+e.g. for a Blog, it could have the following Field definition for each post / Entry:
 
 - an image that is displayed on top of the post (Asset reference)
 - a title to catch users attention (Value)
 - content that contains multiple headlines and paragraphs (Value)
 - an author that wrote the post (Entry reference)
 
-Each definition like the title, contains additional information for the input field, that is used to modify it's Value.
-e.g. the title would be a simple one line input field, that has a maximum lenght of 150 characters and is required for each post. But the content is a markdown editor to easily add formatting. The image let's the user select a jpeg or png from disk. And the author is a reference to another Collection's Entry, so the user is able to choose one of them.
+Each definition like the title, contains additional information for the input Field, that is used to modify it's Value.
+e.g. the title would be a simple one line input Field, that has a maximum lenght of 150 characters and is required for each post. But the content is a markdown editor to easily add formatting. The image let's the user select a jpeg or png from disk. And the author is a reference to another Collection's Entry, so the user is able to choose one of them.
 
 ### Entries
 
-Contains Values and references that follow the Collection's ValueDefinitions. Why references and not the Assets or Entries itself? To make Values reusable for different Entries and even Collections - so when you update an Asset or Entry, it updates everywhere you've referenced it.
+Contains Values and references that follow the Collection's Field definitions. Why references and not the Assets or Entries themself? To make Values reusable for different Entries and even Collections - so when you update an Asset or Entry, it updates everywhere you've referenced it.
 
 ### Values