Skip to content

Commit 951d53e

Browse files
committed
Update README and composer
1 parent da69e45 commit 951d53e

File tree

2 files changed

+16
-23
lines changed

2 files changed

+16
-23
lines changed

README.md

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

8-
This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
8+
This package adds an Uploadcare field to the Backstage CMS.
99

1010
## Installation
1111

@@ -15,37 +15,30 @@ You can install the package via composer:
1515
composer require vormkracht10/backstage-uploadcare-field
1616
```
1717

18-
You can publish and run the migrations with:
19-
20-
```bash
21-
php artisan vendor:publish --tag="backstage-uploadcare-field-migrations"
22-
php artisan migrate
23-
```
24-
25-
You can publish the config file with:
26-
27-
```bash
28-
php artisan vendor:publish --tag="backstage-uploadcare-field-config"
29-
```
30-
31-
This is the contents of the published config file:
18+
Then you need to add the Uploadcare public key to your services.php config file:
3219

3320
```php
3421
return [
22+
'uploadcare' => [
23+
'public_key' => env('UPLOADCARE_PUBLIC_KEY')
24+
]
3525
];
3626
```
3727

38-
Optionally, you can publish the views using
28+
Then you need to add the Uploadcare field to your `backstage.php` config file:
3929

40-
```bash
41-
php artisan vendor:publish --tag="backstage-uploadcare-field-views"
30+
```php
31+
return [
32+
'fields' => [
33+
\Vormkracht10\UploadcareField\UploadcareField::class,
34+
],
35+
];
4236
```
4337

4438
## Usage
4539

4640
```php
47-
$uploadcareField = new Vormkracht10\UploadcareField();
48-
echo $uploadcareField->echoPhrase('Hello, Vormkracht10!');
41+
//
4942
```
5043

5144
## Testing
@@ -68,8 +61,8 @@ Please review [our security policy](../../security/policy) on how to report secu
6861

6962
## Credits
7063

71-
- [Baspa](https://github.com/vormkracht10)
72-
- [All Contributors](../../contributors)
64+
- [Baspa](https://github.com/vormkracht10)
65+
- [All Contributors](../../contributors)
7366

7467
## License
7568

composer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@
8686
"repositories": [
8787
{
8888
"type": "git",
89-
"url": "https://github.com/vormkracht10/filament-uploadcare-field.git"
89+
"url": "git@github.com:vormkracht10/filament-uploadcare-field.git"
9090
},
9191
{
9292
"type": "git",

0 commit comments

Comments
 (0)