Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme #27

Open
LeoUrzua opened this issue Feb 8, 2020 · 0 comments
Open

Update readme #27

LeoUrzua opened this issue Feb 8, 2020 · 0 comments

Comments

@LeoUrzua
Copy link
Collaborator

LeoUrzua commented Feb 8, 2020

After a review from Bergfeld about how easy it would be as "new eyes" to use it

we got some great feedback from him and here are some things that can be improved

- supports and voteOnAttribute

Explain supports and voteOnAttribute in a detailed way, what is their specific function, and why both exist

Matt's explanation:

This is mostly following the pattern that Symfony started
My thought is that they wanted to separate the concerns of:

  • what is this voter concerned with
  • does this user have this permission

- Remove unused/confusing code

Remove the unused import { Voter } in the readme example

Voter is a typescript type.

https://github.com/wizeline/access-decision-manager/blame/master/packages/access-decision-manager/README.md#L42

- Add note for developers

Add a note in the access-decision-manger repo for developers.

Since this repo is going to be mainly used for developers with the intention of binding this functionality to different tools like express, react, vue ... etc.

A note saying something like the next text is helpful
“This package is primarily intended to be used by one of the following (list of express / react / vue bindings)”

- Authorization strategies

Add info about the authorization strategies
#23

LeoUrzua added a commit that referenced this issue Mar 12, 2020
include detailed description of the voter's methods and attributes

re #27
@LeoUrzua LeoUrzua mentioned this issue Mar 12, 2020
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant