Skip to content

Commit 1b43a53

Browse files
committed
update readme
1 parent 8e48fd7 commit 1b43a53

File tree

1 file changed

+22
-6
lines changed

1 file changed

+22
-6
lines changed

README.md

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,10 @@
55
[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/mastashake08/laravel-openai-api/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/mastashake08/laravel-openai-api/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
66
[![Total Downloads](https://img.shields.io/packagist/dt/mastashake08/laravel-openai-api.svg?style=flat-square)](https://packagist.org/packages/mastashake08/laravel-openai-api)
77

8-
This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
8+
## Routes
9+
```
10+
/api/generate-result POST
11+
```
912

1013
## Support us
1114

@@ -26,27 +29,40 @@ composer require mastashake08/laravel-openai-api
2629
You can publish and run the migrations with:
2730

2831
```bash
29-
php artisan vendor:publish --tag="laravel-openai-api-migrations"
32+
php artisan vendor:publish --tag="openai-api-migrations"
3033
php artisan migrate
3134
```
3235

3336
You can publish the config file with:
3437

3538
```bash
36-
php artisan vendor:publish --tag="laravel-openai-api-config"
39+
php artisan vendor:publish --tag="openai-api-config"
3740
```
3841

3942
This is the contents of the published config file:
4043

41-
```php
42-
return [
44+
```return [
45+
46+
/*
47+
|--------------------------------------------------------------------------
48+
| OpenAI API Key and Organization
49+
|--------------------------------------------------------------------------
50+
|
51+
| Here you may specify your OpenAI API Key and organization. This will be
52+
| used to authenticate with the OpenAI API - you can find your API key
53+
| and organization on your OpenAI dashboard, at https://openai.com.
54+
*/
55+
56+
'api_key' => env('OPENAI_API_KEY'),
57+
'organization' => env('OPENAI_ORGANIZATION'),
58+
4359
];
4460
```
4561

4662
Optionally, you can publish the views using
4763

4864
```bash
49-
php artisan vendor:publish --tag="laravel-openai-api-views"
65+
php artisan vendor:publish --tag="openai-api-views"
5066
```
5167

5268
## Usage

0 commit comments

Comments
 (0)