Skip to content

Commit

Permalink
update version
Browse files Browse the repository at this point in the history
  • Loading branch information
ikepu-tp committed Feb 24, 2024
1 parent 49c0973 commit af50f43
Show file tree
Hide file tree
Showing 3 changed files with 113 additions and 1 deletion.
64 changes: 64 additions & 0 deletions README-ja.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# Laravel File Library

これはLaravel用のファイル管理ライブラリです。

## How to use

### インストール

```bash
composer require ikepu-tp/larave-file-library
```

### 設定等のpublish

```bash
php artisan vendor:publish --provider="ikepu_tp\FileLibrary\FileLibraryServiceProvider"
```

### ルーティング

| HTTPメソッド | URI | アクション | ルート名 | 簡単な説明 |
| ------------ | ----------------------- | ---------- | -------------------- | ------------------------------------------------------------ |
| GET | /file/lib | index | file-library.index | ファイルライブラリの一覧を表示します。 |
| GET | /file/lib/create | create | file-library.create | 新しいファイルをアップロードするためのフォームを表示します。 |
| POST | /file/lib | store | file-library.store | ファイルをアップロードします。 |
| GET | /file/lib/{fileId} | show | file-library.show | 特定のファイルの詳細を表示します。 |
| GET | /file/lib/{fileId}/edit | edit | file-library.edit | 特定のファイルの編集フォームを表示します。 |
| PUT/PATCH | /file/lib/{fileId} | update | file-library.update | 特定のファイルを更新します。 |
| DELETE | /file/lib/{fileId} | destroy | file-library.destroy | 特定のファイルを削除します。 |

> [!NOTE]
> `{fileId}` はUUIDです。
#### ファイルのアップロード

```bash
POST http://your-project.com/file/lib
```

| Key | Type | Accepted Values | Required |
| ----- | ------------------ | --------------- | -------- |
| files | Array<int, File> | | Y |
| names | Array<int, string> | max length: 250 | Y |

#### ファイルの編集

```bash
PUT http://your-project.com/file/lib/{fileId}
```

| Key | Type | Accepted Values | Required |
| ---- | ------ | --------------- | -------- |
| name | string | max length: 250 | Y |

## 貢献

貢献は歓迎します!以下の方法で参加できます。

Issue: バグの報告や新機能の提案などに使用してください。
Pull Requests: バグの修正や新機能の追加等の貢献も歓迎します。

## ライセンス

[ライセンス](./LICENSE)を確認してください。
48 changes: 48 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,54 @@ This is a file management library for Laravel.

## How to use

### Install

```bash
composer require ikepu-tp/larave-file-library
```

### Publish configuration etc

```bash
php artisan vendor:publish --provider="ikepu_tp\FileLibrary\FileLibraryServiceProvider"
```

### Routing

| HTTP Method | URI | Action | Route Name | Description |
| ----------- | ----------------------- | ------- | -------------------- | -------------------------------------------- |
| GET | /file/lib | index | file-library.index | Display a list of files in the file library. |
| GET | /file/lib/create | create | file-library.create | Display a form for uploading a new file. |
| POST | /file/lib | store | file-library.store | Upload a file. |
| GET | /file/lib/{fileId} | show | file-library.show | Display details of a specific file. |
| GET | /file/lib/{fileId}/edit | edit | file-library.edit | Display a form for editing a specific file. |
| PUT | /file/lib/{fileId} | update | file-library.update | Update a specific file. |
| DELETE | /file/lib/{fileId} | destroy | file-library.destroy | Delete a specific file. |

> [!NOTE]
> `{fileId}` means uuid.
#### Upload File

```bash
POST http://your-project.com/file/lib
```

| Key | Type | Accepted Values | Required |
| ----- | ------------------ | --------------- | -------- |
| files | Array<int, File> | | Y |
| names | Array<int, string> | max length: 250 | Y |

#### Edit File

```bash
PUT http://your-project.com/file/lib/{fileId}
```

| Key | Type | Accepted Values | Required |
| ---- | ------ | --------------- | -------- |
| name | string | max length: 250 | Y |

## Contributing

We welcome contributions to the project! You can get involved through the following ways:
Expand Down
2 changes: 1 addition & 1 deletion version.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
"version": "0.0.0"
"version": "1.0.0"
}

0 comments on commit af50f43

Please sign in to comment.