Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 18 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# [Hellō](https://www.hello.coop/) Identity Provider (IdP) Client in PHP
# [Hellō][7] Identity Provider (IdP) Client in PHP

| Release | Tests | Coverage |
| :----: | :----: | :------: |
| [![Latest Version](https://img.shields.io/github/release/UnnikrishnanBhargavakurup/hellocoop.svg?style=flat-square)](https://github.com/UnnikrishnanBhargavakurup/hellocoop/releases) | [![Test Status](https://github.com/UnnikrishnanBhargavakurup/hellocoop/actions/workflows/continuous-integration.yml/badge.svg)](https://github.com/UnnikrishnanBhargavakurup/hellocoop/actions) | [![Coverage](https://codecov.io/gh/UnnikrishnanBhargavakurup/hellocoop/graph/badge.svg?token=GFPX13L1TM)](https://codecov.io/gh/UnnikrishnanBhargavakurup/hellocoop) |
| Release | Tests | Coverage |
|:-------------------------:|:----------------------:|:-------------------:|
| [![Latest Version][1]][2] | [![Test Status][3]][4] | [![Coverage][5]][6] |

Hellō enables your users to register and log in using their choice of popular social logins, email, or phone—without tracking them. Hellō is a cloud identity wallet with a mission to empower users to control their digital identities.
Hellō enables your users to register and log in using their choice of popular social logins, email, or phone—without
tracking them. Hellō is a cloud identity wallet with a mission to empower users to control their digital identities.

## Key Features
- **Social Login**: Support for popular providers like Google, Facebook, etc.
Expand All @@ -13,10 +14,10 @@ Hellō enables your users to register and log in using their choice of popular s
- **Quick Integration**: Set up authentication in minutes.

### Developer-Friendly
The easiest and quickest way to onboard and authenticate your users with popular social providers, verified email, and phone. Hellō can be integrated into your application in minutes, not hours.
The easiest and quickest way to onboard and authenticate your users with popular social providers, verified email, and
phone. Hellō can be integrated into your application in minutes, not hours.

## Getting Started

The following example demonstrates how to integrate the Hellō client into your PHP application.

### Installation
Expand All @@ -26,7 +27,6 @@ composer require unnikrishnanbhargavakurup/hellocoop
```

### Usage

```php
use HelloCoop\Config\HelloConfig;
use HelloCoop\HelloClient;
Expand Down Expand Up @@ -67,11 +67,9 @@ if ($requestPath === API_ROUTE) {
```

## Code Quality: Pre-Commit Hook for Linting

To maintain code quality, this project uses a **pre-commit hook** for automatic linting before each commit.

### Setup Instructions

1. **Copy the pre-commit hook to your Git hooks directory**:
```bash
cp pre-commit .git/hooks/
Expand All @@ -85,8 +83,17 @@ To maintain code quality, this project uses a **pre-commit hook** for automatic
This ensures code quality and consistency across the project.

## Contributing
We welcome contributions! Please open an issue or submit a pull request with your changes. Make sure your contributions adhere to the code style guidelines enforced by the pre-commit hook.
We welcome contributions! Please open an issue or submit a pull request with your changes. Make sure your contributions
adhere to the code style guidelines enforced by the pre-commit hook.

## License

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

[1]: https://img.shields.io/github/release/UnnikrishnanBhargavakurup/hellocoop.svg?style=flat-square
[2]: https://github.com/UnnikrishnanBhargavakurup/hellocoop/releases
[3]: https://github.com/UnnikrishnanBhargavakurup/hellocoop/actions/workflows/continuous-integration.yml/badge.svg
[4]: https://github.com/UnnikrishnanBhargavakurup/hellocoop/actions
[5]: https://codecov.io/gh/UnnikrishnanBhargavakurup/hellocoop/graph/badge.svg?token=GFPX13L1TM
[6]: https://codecov.io/gh/UnnikrishnanBhargavakurup/hellocoop
[7]: https://www.hello.coop/
Loading