go/data
Code Issues Pull Requests Activity

Improved documentation

Browse Source
This commit is contained in:
Eduard Urbach 2023-07-06 15:05:59 +02:00
parent 11b4ae49ca
commit 780551c206
Signed by: akyoto
GPG Key ID: C874F672B1AF20C0
1 changed files with 0 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -37,10 +37,4 @@ In a real project you would usually prefix your collections with a project or co
users := ocean.New[User]("google") users := ocean.New[User]("google")
``` ```
## Recommended structure
You can add as many directory hierarchies as you need but I recommend using a simple `/namespace/collection/` structure. You can add as many directory hierarchies as you need but I recommend using a simple `/namespace/collection/` structure.
Collections should use the singular instead of the plural form (`User` instead of `Users`) because it's better for automation.
Ocean does not enforce these standards but they are heavily recommended.