Skip to content

Commit

Permalink
Initial release of @author.io/[email protected]
Browse files Browse the repository at this point in the history
  • Loading branch information
coreybutler committed Oct 9, 2020
1 parent d1d7de7 commit 5fd7855
Show file tree
Hide file tree
Showing 68 changed files with 3,407 additions and 15,556 deletions.
12 changes: 0 additions & 12 deletions .github/FUNDING.yml

This file was deleted.

92 changes: 0 additions & 92 deletions .github/workflows/main.yml

This file was deleted.

2 changes: 1 addition & 1 deletion LICENSE → LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2019 Corey Butler
Copyright (c) 2020 Corey Butler

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
21 changes: 18 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@

Tell other developer network about IAM with a [tweet](https://twitter.com/intent/tweet?hashtags=javascript&original_referer=http%3A%2F%2F127.0.0.1%3A91%2F&text=Check%20out%20IAM%20for%20securing%20websites%20and%20APIs&tw_p=tweetbutton&url=http%3A%2F%2Fgithub.com%2Fcoreybutler%2Fiam&via=goldglovecb).
Tell other developer network about IAM with a [tweet](https://twitter.com/intent/tweet?hashtags=javascript&original_referer=http%3A%2F%2F127.0.0.1%3A91%2F&text=Check%20out%20IAM%20for%20securing%20websites%20and%20APIs&tw_p=tweetbutton&url=http%3A%2F%2Fgithub.com%2Fcoreybutler%2Fiam&via=goldglovecb).

# IAM (Identification and Authorization Management)

IAM is an access control framework for the browser and Node.js. It is lightweight, built on standards, and incredibly powerful.
IAM is an access control framework for all JavaScript runtimes (Browsers, Node.js, Deno, etc). It is lightweight, built on standards, and incredibly powerful.

The library manages roles and permissions, allowing developers to create simple or complex authorization patterns. The **main benefit** is the _ridiculously lightweight_ **query engine**, which primarily answers one question:
The library manages roles and permissions, allowing developers to create simple or complex authorization patterns. The **main benefit** is the _ridiculously lightweight_ **query engine**, which primarily answers one question:

_"Does the user have the right to do something with the system resource?"_

Expand All @@ -17,6 +17,21 @@ if (user.authorized('system resource', 'view')) {
}
```

<table cellpadding="0" cellspacing="10">
<tr>
<td>
<h3>Version 2.0.0-alpha update notice:</h3>
<p>A new major version has been released, though it still functions almost identically to the 1.x.x branch. Here's why:</p>
<ol>
<li>
Version 1.0.0 was created before ES Modules were widely supported. Now that ES Module support is common, the library no longer needs separate packages for distribution.
</li>
<li>This was originally released as a library for <a href="https://butlerlogic.com" target="_blank">Butler Logic</a> clients. Fortunately, it has become a more generic tool, available for a general audience. As such, we've moved the package from <code>@butlerlogic/iam</code> to <code>@author.io/iam</code>. The Author npm organization is more suitable for long term support.</li>
</ol>
</td>
</tr>
</table>

**How it works:**

IAM keeps track of resources, rights, roles, and groups. By maintaining the permission structure within the library (internally), it is capable of automatically deriving user rights, even in complex schemas. It's like a permissions calculator.
Expand Down
14 changes: 0 additions & 14 deletions build/.browserslistrc

This file was deleted.

16 changes: 0 additions & 16 deletions build/config.json

This file was deleted.

80 changes: 0 additions & 80 deletions build/lib/browser-package.js

This file was deleted.

Loading

0 comments on commit 5fd7855

Please sign in to comment.