coolaj86
/
oauth3.js
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

fixed some spelling errors in the README

This commit is contained in:
tigerbot 2017-03-07 14:54:08 -07:00
parent 68cecb7c96
commit 29967cde19
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -6,7 +6,7 @@ The world's smallest, fastest, and most secure OAuth3 (and OAuth2) JavaScript im
Instead of bloating your webapp and ruining the mobile experience, Instead of bloating your webapp and ruining the mobile experience,
you can use a single, small javascript file for all OAuth3 providers you can use a single, small javascript file for all OAuth3 providers
(and almost all OAuth2 providers) with a seemless experience. (and almost all OAuth2 providers) with a seamless experience.
Also, instead of complicated (or worse - insecure) CLI and Desktop login methods, Also, instead of complicated (or worse - insecure) CLI and Desktop login methods,
you can easily integrate an OAuth3 flow (or broker) into any node.js app (i.e. Electron, Node-Webkit) you can easily integrate an OAuth3 flow (or broker) into any node.js app (i.e. Electron, Node-Webkit)
@ -74,7 +74,7 @@ function onClickLogin() {
console.info('Authentication was Successful:'); console.info('Authentication was Successful:');
console.log(session); console.log(session);
// You can use the PPID (or preferrably a hash of it) as the login for your app // You can use the PPID (or preferably a hash of it) as the login for your app
// (it securely functions as both username and password which is known only by your app) // (it securely functions as both username and password which is known only by your app)
// If you use a hash of it as an ID, you can also use the PPID itself as a decryption key // If you use a hash of it as an ID, you can also use the PPID itself as a decryption key
// //
@ -168,7 +168,7 @@ pushd /path/to/your/web/app
# clone the project as assets/org.oauth3 # clone the project as assets/org.oauth3
mkdir -p assets mkdir -p assets
git clone git@git.daplie.com:Daplie/oauth3.js.git assets/org.oauth3 git clone git@git.daplie.com:Daplie/oauth3.js.git assets/org.oauth3
pushd assests/org.oauth3 pushd assets/org.oauth3
git checkout v1 git checkout v1
popd popd
@ -232,7 +232,7 @@ function onClickLogin() {
console.info('Authentication was Successful:'); console.info('Authentication was Successful:');
console.log(session); console.log(session);
// You can use the PPID (or preferrably a hash of it) as the login for your app // You can use the PPID (or preferably a hash of it) as the login for your app
// (it securely functions as both username and password which is known only by your app) // (it securely functions as both username and password which is known only by your app)
// If you use a hash of it as an ID, you can also use the PPID itself as a decryption key // If you use a hash of it as an ID, you can also use the PPID itself as a decryption key
// //
@ -448,7 +448,7 @@ As a general rule I don't like rules that sometimes apply and sometimes don't,
so I may need to rethink this. However, there are cases where including the protocol so I may need to rethink this. However, there are cases where including the protocol
can be very ugly and confusing and we definitely need to allow relative paths. can be very ugly and confusing and we definitely need to allow relative paths.
A potential work-around would be to assume all paths are relative (elimitate #4 instead) A potential work-around would be to assume all paths are relative (eliminate #4 instead)
and have the path always key off of the base URL - if oauth3 directives are to be found at and have the path always key off of the base URL - if oauth3 directives are to be found at
https://example.com/username/.well-known/oauth3/directives.json then /api/whatever would refer https://example.com/username/.well-known/oauth3/directives.json then /api/whatever would refer
to https://example.com/username/api/whatever. to https://example.com/username/api/whatever.