Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
warcooft committed Sep 14, 2024
1 parent 082657b commit e21fcdd
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
[Farsi](./README.fa-IR.md) | English
## Codeigniter Shield OAuth

## Codeigniter Shield OAuth

[![PHPCSFixer](/~https://github.com/datamweb/shield-oauth/actions/workflows/phpcsfixer.yml/badge.svg)](/~https://github.com/datamweb/shield-oauth/actions/workflows/phpcsfixer.yml)
[![PHPStan](/~https://github.com/datamweb/shield-oauth/actions/workflows/phpstan.yml/badge.svg)](/~https://github.com/datamweb/shield-oauth/actions/workflows/phpstan.yml)
[![Rector](/~https://github.com/datamweb/shield-oauth/actions/workflows/rector.yml/badge.svg)](/~https://github.com/datamweb/shield-oauth/actions/workflows/rector.yml)
[![PHPCPD](/~https://github.com/datamweb/shield-oauth/actions/workflows/phpcpd.yml/badge.svg)](/~https://github.com/datamweb/shield-oauth/actions/workflows/phpcpd.yml)


<p align="center"><img src="/~https://github.com/datamweb/my-repository-files/blob/main/shield-oauth/image/shieldOAuthLogo.png" alt="Logo Shield OAuth"></p>

[![Latest Stable Version](https://poser.pugx.org/datamweb/shield-oauth/v?style=for-the-badge)](https://packagist.org/packages/datamweb/shield-oauth) [![Total Downloads](https://poser.pugx.org/datamweb/shield-oauth/downloads?style=for-the-badge)](https://packagist.org/packages/datamweb/shield-oauth) [![Latest Unstable Version](https://poser.pugx.org/datamweb/shield-oauth/v/unstable?style=for-the-badge)](https://packagist.org/packages/datamweb/shield-oauth) [![License](https://poser.pugx.org/datamweb/shield-oauth/license?style=for-the-badge)](https://packagist.org/packages/datamweb/shield-oauth) [![PHP Version Require](https://poser.pugx.org/datamweb/shield-oauth/require/php?style=for-the-badge)](https://packagist.org/packages/datamweb/shield-oauth)


`Shield OAuth` helps you to provide the possibility of login or registering users through the OAuth service. Currently, `Shield OAuth` supports `Google OAuth` and `GitHub OAuth` by default, but it allows you to implement it for any other service, including **Yahoo**, **Facebook**, **Twitter**, **LinkedIn**, **GitLab** and ...
`Shield OAuth` helps you to provide the possibility of login or registering users through the OAuth service. Currently, `Shield OAuth` supports `Google OAuth`, `GitHub and `Microsoft` OAuth` by default, but it allows you to implement it for any other service, including **Yahoo**, **Facebook**, **Twitter**, **LinkedIn**, **GitLab** and ...

In `Shield OAuth`, it has been considered to be easy to use by developers and the possibility of expansion to connect to other services in the shortest possible time.

Expand All @@ -25,12 +25,15 @@ In `Shield OAuth`, it has been considered to be easy to use by developers and th
- [cURL Library](https://www.php.net/manual/en/book.curl.php) to be installed in your version of PHP

## Shield OAuth Documentation

In the documentation, I have explained how to **install**, **configure**, and how to **create custom class `NewOAuth`** connections to other services. Documentation for `Shield OAuth` can be found on the [docs](https://www.shield-oauth.codeigniter4.ir/).

## License

This project is licensed under the MIT License - see the [LICENSE](/LICENSE) file for details.

## Acknowledgements

Every open-source project depends on it's contributors to be a success. The following users have contributed in one manner or another in making Codeigniter `Shield OAuth`:

<a href="/~https://github.com/datamweb/shield-oauth/graphs/contributors">
Expand Down

0 comments on commit e21fcdd

Please sign in to comment.