Skip to content

Commit

Permalink
chore: rename package
Browse files Browse the repository at this point in the history
  • Loading branch information
sourabpramanik committed Jul 25, 2024
1 parent e937027 commit 65ece77
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 15 deletions.
10 changes: 5 additions & 5 deletions .github/workflows/beta-release.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Release Beta
name: Release beta

on:
push:
Expand All @@ -18,10 +18,10 @@ jobs:
- name: Install the dependencies
run: pnpm install

- name: Configure npm for authentication
run: |
echo "//registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}" > ~/.npmrc
echo "@payloadcms:registry=https://your-custom-registry-url/" >> ~/.npmrc
- name: Initialise the NPM config
run: pnpm config set //registry.npmjs.org/:_authToken $NPM_TOKEN
env:
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

- name: Initialize Git user
run: |
Expand Down
1 change: 0 additions & 1 deletion .release-it.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ npm:
github:
release: true
releaseName: "Release ${version}"
releaseNotes: "auto-generate"

hooks:
before:init:
Expand Down
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

> **Note: This plugin supports all versions of Payload CMS starting from version 3.0 and above.**
# PayloadCMS OAuth Plugin
# Authentication plugin for PayloadCMS
This plugin is designed to simplify the integration of multiple Open Authorization (OAuth) and OpenID Connect providers with Payload CMS. Developers can quickly and effortlessly set up authentication mechanisms by leveraging pre-configured providers.

## How it works?
Expand All @@ -22,21 +22,21 @@ If you already have a collection with the slug `accounts`, it can cause a confli
For every provider with different protocols, the endpoints are already configured in the plugin. So any request that comes to the `/api/oauth/**/*` route will be handled by the plugin.

### Signin UI component
The OAuth signin component is added to the signin page when you integrate the plugin. It can be customized by passing the relevant configuration options.
The auth signin component is added to the signin page when you integrate the plugin. It can be customized by passing the relevant configuration options.

## Usage

### Install the plugin
```bash
npm install plugin-payload-oauth
npm install payload-auth-plugin
```
Or
```bash
yarn add plugin-payload-oauth
yarn add payload-auth-plugin
```
Or
```bash
pnpm add plugin-payload-oauth
pnpm add payload-auth-plugin
```
### Create an OAuth app
In your desired provider, create an OAuth application. Depending on your provider, you will need to obtain the Client ID and Client Secret from the provider's console or dashboard. Please refer to the [providers list](https://github.com/sourabpramanik/plugin-payload-oauth?tab=readme-ov-file#list-of-active-and-upcoming-providers) for detailed instructions on configuring a specific provider.
Expand All @@ -60,9 +60,9 @@ Import the plugin in `src/payload.config.ts` and set up a provider:

import { buildConfig } from 'payload/config'
// --- rest of the imports
import AuthPlugin from '@payloadcms/payload-plugin-oauth'
import AuthPlugin from '@payloadcms/plugin-payload-oauth/styles'
import { GoogleAuthProvider } from '@payloadcms/plugin-payload-oauth/providers'
import AuthPlugin from 'payload-auth-plugin'
import AuthPlugin from 'payload-auth-plugin'
import { GoogleAuthProvider } from 'payload-auth-plugin'

export default buildConfig({
// --- rest of the config
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "@payloadcms/payload-plugin-oauth",
"name": "payload-plugin-auth",
"version": "0.0.0",
"type": "module",
"author": "Sourab Pramanik<[email protected]>",
Expand Down

0 comments on commit 65ece77

Please sign in to comment.