From a1ddd12b8ec082fa6af530085a8dfcdca3283880 Mon Sep 17 00:00:00 2001 From: Badisi Date: Tue, 16 Apr 2024 17:03:14 +0200 Subject: [PATCH] docs(README): improvements --- README.md | 15 +++++++++++---- projects/auth-js/README.md | 13 +++++++++---- projects/ngx-auth/README.md | 13 +++++++++---- 3 files changed, 29 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 85d998a..a7becf4 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,28 @@ +
+ # 🛡️ Auth-js -Authentication and authorization support for web based desktop and mobile applications. +Authentication and authorization support for web based desktop and mobile applications. -[![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] + +
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 +
+
## 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]. @@ -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 diff --git a/projects/auth-js/README.md b/projects/auth-js/README.md index ade7ddc..0255585 100644 --- a/projects/auth-js/README.md +++ b/projects/auth-js/README.md @@ -1,3 +1,5 @@ +
+ # @badisi/auth-js 🛡️ Authentication and authorization support for web based desktop and mobile applications. @@ -5,16 +7,19 @@ [![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] +
+
## 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]. @@ -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 diff --git a/projects/ngx-auth/README.md b/projects/ngx-auth/README.md index a931612..38f48e9 100644 --- a/projects/ngx-auth/README.md +++ b/projects/ngx-auth/README.md @@ -1,3 +1,5 @@ +
+ # @badisi/ngx-auth 🛡️ Authentication and authorization support for Angular based desktop and mobile applications. @@ -5,16 +7,19 @@ [![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] +
+
## 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]. @@ -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