Skip to content

Commit

Permalink
update readme and changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
rahmanramsi committed Jul 21, 2021
1 parent 2ce025c commit 985d442
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 8 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

All notable changes to `core` will be documented in this file

## 1.0.0 - 201X-XX-XX
## 0.1-Alpha - 21 July 2021

- initial release
29 changes: 22 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@
[![Total Downloads](https://img.shields.io/packagist/dt/openjournalteam/core.svg?style=flat-square)](https://packagist.org/packages/openjournalteam/core)
![GitHub Actions](https://github.com/openjournalteam/core/actions/workflows/main.yml/badge.svg)

This is where your description should go. Try and limit it to a paragraph or two, and maybe throw in a mention of what PSRs you support to avoid any confusion with users and contributors.

## Installation

You can install the package via composer:
Expand All @@ -16,10 +14,31 @@ composer require openjournalteam/core

## Usage

Run the following to use the latest stable version
```php
php artisan core:install
```
Edit config/auth.php and add the following lines:
```php
'providers' => [
'users' => [
'driver' => 'eloquent',
'model' => App\User::class,
],
],
```
To
```php
// Usage description here
'providers' => [
'users' => [
'driver' => 'eloquent',
'model' => OpenJournalTeam\Core\Models\User::class,
],
],
```



### Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
Expand All @@ -36,7 +55,3 @@ If you discover any security related issues, please email [email protected]

- [Rahman Ramsi](https://github.com/rhmrms)
- [All Contributors](../../contributors)

## License

The The Unlicense. Please see [License File](LICENSE.md) for more information.

0 comments on commit 985d442

Please sign in to comment.