search

integreat-io / integreat

Node.js integration layer
Other
14 stars 3 forks source link

Feedback on README.md #225

Closed simenflatby closed 1 year ago

simenflatby commented 1 year ago

Hi. Here are some feedback on the README.md as you wanted.

More Details or Clarify?

  1. generateId: What is the format of this ID? Is the format configurable?
  2. roles: A list of roles or permissions given to this ident. My perception after reading the rest of the README.md is that permission based authorization is not supported, only role based, but here permissions are mentioned. Are permissions supported? See https://www.baeldung.com/cs/role-vs-permission-based-access-control for differences.

Possible Addons

  1. Table of contents. Can be autogenerated from Markdown.
  2. Info on how to do debugging with stepping.
  3. Info on best practice of how to scale an application built on integreat. Should it be scaled horizontally or vertically?
  4. Info on best practice for unit and integration testing.
  5. Example repo with working application built with best practices that can be cloned and started.
kjellmorten commented 1 year ago

Thanks for great feedback, @simenflatby!

  1. I have specified the format in the README, and also included a test for it.
  2. You're right. I have removed the term "permissions" to not be misleading. We might support a permission based model in the future, but we'll describe that when it's ready.

I've added a TOC too. The other "Possible Addons" are great too, but I'll have to save them for later. 😅