From 9f4cbf414e1b41f448b2a36d759a035786d26668 Mon Sep 17 00:00:00 2001
From: meesvandongen <35409045+meesvandongen@users.noreply.github.com>
Date: Fri, 7 Jun 2024 16:26:50 +0900
Subject: [PATCH] fix(oidc): 2 readmes with the same name (release) (#1377)
* remove all readmes
* re-add readme
---
readme.md | 181 ------------------------------------------------------
1 file changed, 181 deletions(-)
delete mode 100644 readme.md
diff --git a/readme.md b/readme.md
deleted file mode 100644
index 038c38352..000000000
--- a/readme.md
+++ /dev/null
@@ -1,181 +0,0 @@
-# @axa-fr/oidc-client
-
-[](https://github.com/AxaFrance/react-oidc/actions/workflows/npm-publish.yml)
-[](https://sonarcloud.io/dashboard?id=AxaGuilDEv_react-oidc) [](https://sonarcloud.io/component_measures?id=AxaGuilDEv_react-oidc&metric=reliability_rating) [](https://sonarcloud.io/component_measures?id=AxaGuilDEv_react-oidc&metric=security_rating) [](https://sonarcloud.io/component_measures?id=AxaGuilDEv_react-oidc&metric=Coverage) [](https://twitter.com/intent/follow?screen_name=GuildDEvOpen)
-
-
-
- 
-
-
-- [About](#about)
-- [Getting Started](#getting-started)
-- [Run The Demos](#run-the-demos)
-- [How It Works](#how-it-works)
-- Packages
- - [`@axa-fr/oidc-client`](./packages/oidc-client#readme.md) [](https://badge.fury.io/js/%40axa-fr%2Foidc-client)
- - [`@axa-fr/react-oidc`](./packages/react-oidc#readme.md) [](https://badge.fury.io/js/%40axa-fr%2Freact-oidc)
- - `@axa-fr/svelte-oidc` : we are looking for contributor
- - `@axa-fr/vue-oidc` : we are looking for contributor
- - `@axa-fr/angular-oidc` : we are looking for contributor
-- [FAQ](#FAQ)
-- [Migrations](#migrations)
-- [Contribute](#contribute)
-
-## About
-
-**@axa-fr/oidc-client** the lightest and securest library to manage authentication with OpenID Connect (OIDC) and OAuth2 protocol. It is compatible with all OIDC providers.
-**@axa-fr/oidc-client** is a pure javascript library. It works with any JavaScript framework or library.
-**@axa-fr/react-oidc** is for **React** (compatible next.js, etc.), we expect soon to provide one for **Vue**, **Angular** and **Svelte**.
-
-Demos:
-- Try the react demo at https://black-rock-0dc6b0d03.1.azurestaticapps.net/ (most advanced)
-- Try the pure javascript demo at https://icy-glacier-004ab4303.2.azurestaticapps.net/
-
-
-**@axa-fr/oidc-client** is:
-
-- **Secure** :
- - With Demonstrating Proof of Possession (DPoP), your access_token and refresh_token are not usable outside your browser context (big protection)
- - With the use of Service Worker, your tokens (refresh_token and/or access_token) are not accessible to the JavaScript client code (if you follow good practices from [`FAQ`](https://github.com/AxaFrance/oidc-client/blob/main/FAQ.md) section)
- - OIDC using client side Code Credential Grant with pkce only
-- **Lightweight** : Unpacked Size on npm is **274 kB**
-- **Simple**
- - refresh_token and access_token are auto refreshed in background
- - with the use of the Service Worker, you do not need to inject the access_token in every fetch, you have only to configure OidcTrustedDomains.js file
-- **Multiple Authentication** :
- - You can authenticate many times to the same provider with different scope (for example you can acquire a new 'payment' scope for a payment)
- - You can authenticate to multiple different providers inside the same SPA (single page application) website
-- **Flexible** :
- - Work with Service Worker (more secure) and without for older browser (less secure).
- - You can disable Service Worker if you want (but less secure) and just use SessionStorage or LocalStorage mode.
-
-Works perfectly well with:
-
-- [Auth0](https://auth0.com/)
-- [Duende Identity Server](https://duendesoftware.com/)
-- Azure AD
-- Google
-- AWS
-- [Keycloak](https://www.keycloak.org/)
-- etc., all OIDC providers
-
-
-## Getting Started
-
-### Getting Started with @axa-fr/oidc-client
-
-```sh
-npm install @axa-fr/oidc-client --save
-
-# To install or update OidcServiceWorker.js file, you can run
-node ./node_modules/@axa-fr/oidc-client/bin/copy-service-worker-files.mjs public
-
-# If you have a "public" folder, the 2 files will be created :
-# ./public/OidcServiceWorker.js <-- will be updated at each "npm install"
-# ./public/OidcTrustedDomains.js <-- won't be updated if already exist
-```
-
-WARNING : If you use Service Worker mode, the OidcServiceWorker.js file should always be up to date with the version of the library. You may setup a postinstall script in your package.json file to update it at each npm install. For example :
-```sh
- "scripts": {
- ...
- "postinstall": "node ./node_modules/@axa-fr/oidc-client/bin/copy-service-worker-files.mjs public"
- },
-```
-
-More documentation :
-
-- [`@axa-fr/oidc-client`](./packages/oidc-client#readme)
-
-### Getting Started with @axa-fr/react-oidc
-
-```sh
-npm install @axa-fr/react-oidc --save
-
-# To install or update OidcServiceWorker.js file, you can run
-node ./node_modules/@axa-fr/react-oidc/bin/copy-service-worker-files.mjs public
-
-# If you have a "public" folder, the 2 files will be created :
-# ./public/OidcServiceWorker.js <-- will be updated at each "npm install"
-# ./public/OidcTrustedDomains.js <-- won't be updated if already exist
-```
-
-WARNING : If you use Service Worker mode, the OidcServiceWorker.js file should always be up to date with the version of the library. You may setup a postinstall script in your package.json file to update it at each npm install. For example :
-```sh
- "scripts": {
- ...
- "postinstall": "node ./node_modules/@axa-fr/react-oidc/bin/copy-service-worker-files.mjs public"
- },
-```
-
-More documentation :
-
-- [`@axa-fr/react-oidc`](./packages/react-oidc#readme)
-
-## Run The Demos
-
-```sh
-git clone https://github.com/AxaFrance/oidc-client.git
-
-cd oidc-client
-pnpm install
-
-# oidc client demo
-cd examples/oidc-client-demo
-pnpm install
-pnpm start
-# then navigate to http://localhost:5174
-
-# react vite demo
-cd examples/react-oidc-demo
-pnpm install
-pnpm start
-# then navigate to http://localhost:4200
-
-# react NextJS demo
-cd examples/nextjs-demo
-pnpm install
-pnpm run dev
-# then navigate to http://localhost:3001
-```
-
-## How It Works
-
-
- 
-
- The service worker catch access_token and refresh_token that will never be accessible to the client.
-
-
-
-These components encapsulate the use of "`@axa-fr/oidc-client`" in order to hide workflow complexity.
-Internally for "`@axa-fr/react-oidc`", native History API is used to be router library agnostic.
-
-More information about OIDC :
-
-- [French : Augmentez la sécurité et la simplicité de votre Système d’Information OpenID Connect](https://medium.com/just-tech-it-now/augmentez-la-s%C3%A9curit%C3%A9-et-la-simplicit%C3%A9-de-votre-syst%C3%A8me-dinformation-avec-oauth-2-0-cf0732d71284)
-- [English : Increase the security and simplicity of your information system with OpenID Connect](https://medium.com/just-tech-it-now/increase-the-security-and-simplicity-of-your-information-system-with-openid-connect-fa8c26b99d6d)
-- [English: youtube react-oidc introduction](https://www.youtube.com/watch?v=frIJfavZkUE&list=PL8EMdIH6Mzxy2kHtsVOEWqNz-OaM_D_fB&index=1)
-- [French: youtube react-oidc introduction](https://www.youtube.com/watch?v=H-mLMGzQ_y0&list=PL8EMdIH6Mzxy2kHtsVOEWqNz-OaM_D_fB&index=2)
-
-## FAQ
-
-- Frequented Asked Question [`FAQ`](./FAQ.md)
-
-## Migrations
-
-- Migrating from v3 to v4 [`guide`](./MIGRATION_GUIDE_V3_TO_V4.md)
-- Migrating from v3 to v5 [`guide`](./MIGRATION_GUIDE_V3_TO_V5.md)
-- Migrating from v4 to v5 [`guide`](./MIGRATION_GUIDE_V4_TO_V5.md)
-- Migrating from v5 to v6 [`guide`](./MIGRATION_GUIDE_V5_TO_V6.md)
-- Migrating from v6 to v7 [`guide`](./MIGRATION_GUIDE_V6_TO_V7.md)
-
-## Contribute
-
-- [How to run the solution and to contribute](./CONTRIBUTING.md)
-- [Please respect our code of conduct](./CODE_OF_CONDUCT.md)