Skip to content

Update README.md #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mohammadalgunaid wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #22

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@

### How to use

To inject service user extension method `AddYandexObjectStorage` to `IServiceCollection`
To inject service user extension method `AddYandexObjectStorage` to `IServiceCollection`:

```
```C#
services.AddYandexObjectStorage(options =>
{
options.BucketName = "bucketName";
Expand All @@ -21,7 +21,7 @@ services.AddYandexObjectStorage(options =>

Can load options from `IConfiguratiuonRoot` as: `services.AddYandexObjectStorage(Configuration);`
by default, it reads a section with the name `YandexObjectStorage`, for example, the section in `appsettings.json` below:
```
```json
"YandexObjectStorage" : {
"Bucket" : "your-bucket",
"AccessKey" : "your-access-key",
Expand All @@ -32,7 +32,7 @@ by default, it reads a section with the name `YandexObjectStorage`, for example,

Options is a `YandexStorageOptions` class.
It provides access to setup next properties:
```
```C#
string Protocol - by default -> "https"
string BucketName
string Location - by default -> "us-east-1"
Expand All @@ -43,13 +43,13 @@ string SecretKey

## Usage examples

```
```C#
S3PutResponse response = await _objectStoreService.ObjectService.PutAsync(byteArr, fileName);
S3DeleteResponse response = await _objectStoreService.ObjectService.DeleteAsync(filename);
```
Get can return as Stream or ByteArray
Get can return as Stream or ByteArray:

```
```C#
// result is FluentResults wrapped content of result
var result = await _objectStoreService.ObjectService.GetAsync(fileName);
if(result.IsSuccess)
Expand Down