Skip to content

Commit

Permalink
docs(README): improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
Badisi committed Apr 16, 2024
1 parent a0c7057 commit a1ddd12
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 12 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,28 @@
<div align="center">

# 🛡️ Auth-js

Authentication and authorization support for web based desktop and mobile applications.
<i>Authentication and authorization support for web based desktop and mobile applications.</i>

[![build status](https://github.com/Badisi/auth-js/actions/workflows/ci_tests.yml/badge.svg)][ci-tests]
[![build status](https://github.com/badisi/auth-js/actions/workflows/ci_tests.yml/badge.svg)][ci-tests]
[![PRs welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)][pullrequest]
[![docs site](https://img.shields.io/badge/docs-site-blue)][docs-site]

<br/>

Package | Version | Downloads | License | Description
--- | --- | --- | --- | ---
[@badisi/auth-js](/projects/auth-js) | [![npm version](https://img.shields.io/npm/v/@badisi/auth-js.svg?color=blue&logo=npm)][npm-auth-js] | [![npm downloads](https://img.shields.io/npm/dw/@badisi/auth-js.svg?color=7986CB&logo=npm&label=npm)][npm-dl-auth-js] | [![license](https://img.shields.io/npm/l/@badisi/auth-js.svg?color=ff69b4&label=)][license] | For VanillaJS, Ionic applications
[@badisi/ngx-auth](/projects/ngx-auth) | [![npm version](https://img.shields.io/npm/v/@badisi/ngx-auth.svg?color=blue&logo=npm)][npm-ngx-auth] | [![npm downloads](https://img.shields.io/npm/dw/@badisi/ngx-auth.svg?color=7986CB&logo=npm&label=npm)][npm-dl-ngx-auth] | [![license](https://img.shields.io/npm/l/@badisi/ngx-auth.svg?color=ff69b4&label=)][license] | For Angular, Ionic applications

</div>

<hr/>


## Getting started

👉 Learn about it on the [docs site][docs-site].
👉 Learn about it on the 📚 [docs site][docs-site].

🎈 Play with it on the [demo site][demo-site].

Expand Down Expand Up @@ -44,7 +51,7 @@ Please read and follow the [Code of Conduct][codeofconduct] and help me keep thi
[npm-ngx-auth]: https://www.npmjs.com/package/@badisi/ngx-auth
[npm-dl-auth-js]: https://npmcharts.com/compare/@badisi/auth-js?minimal=true
[npm-dl-ngx-auth]: https://npmcharts.com/compare/@badisi/ngx-auth?minimal=true
[ci-tests]: https://github.com/Badisi/auth-js/actions/workflows/ci_tests.yml
[ci-tests]: https://github.com/badisi/auth-js/actions/workflows/ci_tests.yml
[pullrequest]: https://github.com/badisi/auth-js/blob/main/CONTRIBUTING.md#-submitting-a-pull-request-pr
[license]: https://github.com/badisi/auth-js/blob/main/LICENSE
[developer]: https://github.com/badisi/auth-js/blob/main/DEVELOPER.md
Expand Down
13 changes: 9 additions & 4 deletions projects/auth-js/README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,25 @@
<div align="center">

# @badisi/auth-js

🛡️ Authentication and authorization support for web based desktop and mobile applications.

[![npm version](https://img.shields.io/npm/v/@badisi/auth-js.svg?color=blue&logo=npm)][npm]
[![npm downloads](https://img.shields.io/npm/dw/@badisi/auth-js.svg?color=7986CB&logo=npm)][npm-dl]
[![license](https://img.shields.io/npm/l/@badisi/auth-js.svg?color=ff69b4)][license]
[![docs site](https://img.shields.io/badge/docs-site-blue)][docs-site]

[![build status](https://github.com/badisi/auth-js/workflows/CI%20tests/badge.svg)][ci-tests]
[![build status](https://github.com/badisi/auth-js/actions/workflows/ci_tests.yml/badge.svg)][ci-tests]
[![PRs welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)][pullrequest]

</div>

<hr/>


## Getting started

👉 Learn about it on the [docs site][docs-site].
👉 Learn about it on the 📚 [docs site][docs-site].

🎈 Play with it on the [demo site][demo-site].

Expand All @@ -41,11 +46,11 @@ Please read and follow the [Code of Conduct][codeofconduct] and help me keep thi

[npm]: https://www.npmjs.com/package/@badisi/auth-js
[npm-dl]: https://npmcharts.com/compare/@badisi/auth-js?minimal=true
[ci-tests]: https://github.com/badisi/auth-js/actions?query=workflow:CI%20tests
[ci-tests]: https://github.com/badisi/auth-js/actions/workflows/ci_tests.yml
[pullrequest]: https://github.com/badisi/auth-js/blob/main/CONTRIBUTING.md#-submitting-a-pull-request-pr
[license]: https://github.com/badisi/auth-js/blob/main/LICENSE
[developer]: https://github.com/badisi/auth-js/blob/main/DEVELOPER.md
[contributing]: https://github.com/badisi/auth-js/blob/main/CONTRIBUTING.md
[codeofconduct]: https://github.com/badisi/auth-js/blob/main/CODE_OF_CONDUCT.md
[docs-site]: https://badisi.github.io/auth-js/site/docs/intro
[docs-site]: https://badisi.github.io/auth-js/site/documentation/getting-started/vanilla-js
[demo-site]: https://badisi.github.io/auth-js/demo-app/auth-js
13 changes: 9 additions & 4 deletions projects/ngx-auth/README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,25 @@
<div align="center">

# @badisi/ngx-auth

🛡️ Authentication and authorization support for Angular based desktop and mobile applications.

[![npm version](https://img.shields.io/npm/v/@badisi/ngx-auth.svg?color=blue&logo=npm)][npm]
[![npm downloads](https://img.shields.io/npm/dw/@badisi/ngx-auth.svg?color=7986CB&logo=npm)][npm-dl]
[![license](https://img.shields.io/npm/l/@badisi/ngx-auth.svg?color=ff69b4)][license]
[![docs site](https://img.shields.io/badge/docs-site-blue)][docs-site]

[![build status](https://github.com/badisi/auth-js/workflows/CI%20tests/badge.svg)][ci-tests]
[![build status](https://github.com/badisi/auth-js/actions/workflows/ci_tests.yml/badge.svg)][ci-tests]
[![PRs welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)][pullrequest]

</div>

<hr/>


## Getting started

👉 Learn about it on the [docs site][docs-site].
👉 Learn about it on the 📚 [docs site][docs-site].

🎈 Play with it on the [demo site][demo-site].

Expand All @@ -41,11 +46,11 @@ Please read and follow the [Code of Conduct][codeofconduct] and help me keep thi

[npm]: https://www.npmjs.com/package/@badisi/ngx-auth
[npm-dl]: https://npmcharts.com/compare/@badisi/ngx-auth?minimal=true
[ci-tests]: https://github.com/badisi/auth-js/actions?query=workflow:CI%20tests
[ci-tests]: https://github.com/badisi/auth-js/actions/workflows/ci_tests.yml
[pullrequest]: https://github.com/badisi/auth-js/blob/main/CONTRIBUTING.md#-submitting-a-pull-request-pr
[license]: https://github.com/badisi/auth-js/blob/main/LICENSE
[developer]: https://github.com/badisi/auth-js/blob/main/DEVELOPER.md
[contributing]: https://github.com/badisi/auth-js/blob/main/CONTRIBUTING.md
[codeofconduct]: https://github.com/badisi/auth-js/blob/main/CODE_OF_CONDUCT.md
[docs-site]: https://badisi.github.io/auth-js/site/docs/intro
[docs-site]: https://badisi.github.io/auth-js/site/documentation/getting-started/angular
[demo-site]: https://badisi.github.io/auth-js/demo-app/ngx-auth

0 comments on commit a1ddd12

Please sign in to comment.