Merge pull request #8 from brionmario/restructure

Add README to the artifact

.github/workflows/builder.yml

@@ -0,0 +1,56 @@
+# This workflow will build the 
+
+name: 🧱 Builder
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+concurrency: ${{ github.workflow }}-${{ github.ref }}
+
+env:
+  GH_TOKEN: ${{ secrets.RELEASE_BOT_TOKEN }}
+
+jobs:
+  release:
+    name: 📦 Release
+    if: "!contains(github.event.head_commit.message, 'ci skip') && !contains(github.event.head_commit.message, 'skip ci')"
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [lts/*]
+        pnpm-version: [latest]
+    steps:
+      - name: ⬇️ Checkout
+        id: checkout
+        uses: actions/[email protected]
+        with:
+          fetch-depth: 0
+          token: ${{ env.GH_TOKEN }}
+
+      - name: 🟢 Setup node
+        id: setup-node
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: 🥡 Setup pnpm
+        id: setup-pnpm
+        uses: pnpm/[email protected]
+        with:
+          version: ${{ matrix.pnpm-version }}
+          run_install: false
+
+      - name: 🎈 Get pnpm store directory
+        id: get-pnpm-cache-dir
+        run: |
+          echo "::set-output name=pnpm_cache_dir::$(pnpm store path)"
+      - name: 🧩 Install Dependencies
+        id: install-dependencies
+        run: pnpm install
+
+      - name: 🏗️ Build
+        id: build
+        run: pnpm build

.github/workflows/release.yml

@@ -56,6 +56,12 @@ jobs:
         id: build
         run: pnpm build
 
+      - name: 📦 Prepare for Publish
+        id: prepare-for-publish
+        run: |
+          # Copy the README.md file to the lib directory.
+          cp README.md lib
+
       - name: 📣 Create Release Pull Request or Publish to npm
         id: changesets
         uses: changesets/action@v1

README.md

@@ -0,0 +1,41 @@
+<h1 align="center" style="color: #343a40;margin: 20px 0;">
+  <p align="center">Passport Asgardeo</p>
+</h1>
+
+<div align="center">
+  <a href="https://github.com/asgardeo/passport-asgardeo/actions/workflows/release.yml"><img src="https://github.com/asgardeo/passport-asgardeo/actions/workflows/release.yml/badge.svg" alt="🚀 Release"></a>
+  <a href="https://github.com/asgardeo/passport-asgardeo/actions/workflows/builder.yml"><img src="https://github.com/asgardeo/passport-asgardeo/actions/workflows/builder.yml/badge.svg" alt="🧱 Builder"></a>
+
+  <a href="https://stackoverflow.com/questions/tagged/wso2is"><img src="https://img.shields.io/badge/Ask%20for%20help%20on-Stackoverflow-orange" alt="Stackoverflow"></a>
+  <a href="https://discord.gg/wso2"><img src="https://img.shields.io/badge/Join%20us%20on-Discord-%23e01563.svg" alt="Discord"></a>
+  <a href="https://github.com/asgardeo/passport-asgardeo/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" alt="License"></a>
+  <a href="https://twitter.com/intent/follow?screen_name=wso2"><img src="https://img.shields.io/twitter/follow/wso2.svg?style=social&label=Follow" alt="Twitter"></a>
+</div>
+
+<br>
+
+[Passport](https://www.passportjs.org/) strategy for authenticating with [Asgardeo](https://wso2.com/asgardeo)
+using [OAuth 2.0](https://www.passportjs.org/features/oauth2/).
+
+This module lets you authenticate using Asgardeo in your Node.js applications.
+By plugging into Passport, Asgardeo Login can be easily and unobtrusively
+integrated into any application or framework that supports
+[Connect](https://github.com/senchalabs/connect#readme)-style middleware,
+including [Express](https://expressjs.com/).
+
+## Install
+
+```sh
+$ npm install @asgardeo/passport-asgardeo
+```
+
+## Contribute
+Please read [Contributing Guide](CONTRIBUTING.md) for details on how to contribute to Passport Asgardeo. Refer to [General Contribution Guidelines](http://wso2.github.io/) for details on our code of conduct, and the process for submitting pull requests to us.
+
+### Reporting issues
+We encourage you to report issues, improvements, and feature requests creating [Github Issues](https://github.com/asgardeo/passport-asgardeo/issues).
+
+**Important**: Please be advised that security issues MUST be reported to <a href="mailto:[email protected]">security@wso2com</a>, not as GitHub issues, in order to reach the proper audience. We strongly advise following the WSO2 Security Vulnerability Reporting Guidelines when reporting the security issues.
+
+## License
+This project is licensed under the Apache License 2.0. See the [LICENSE](LICENSE) file for details.