wirm/Game/Assets/Supabase/supabase-storage-csharp.1.4.0/README.md

66 lines
2.3 KiB
Markdown

<p align="center">
<img width="300" src=".github/supabase-storage.png"/>
</p>
<p align="center">
<img src="https://github.com/supabase-community/storage-csharp/workflows/Build%20And%20Test/badge.svg"/>
<a href="https://www.nuget.org/packages/supabase-storage-csharp/">
<img src="https://img.shields.io/nuget/vpre/supabase-storage-csharp"/>
</a>
</p>
Integrate your [Supabase](https://supabase.io) projects with C#.
**NOTICE, As of v1.1.0**
**API Change [Breaking/Minor] Library no longer uses `WebClient` and instead leverages `HttpClient`. Progress events on `Upload` and `Download` are now handled with `EventHandler<float>` instead of `WebClient` EventHandlers.**
## Examples (using supabase-csharp)
```c#
public async void Main()
{
// Make sure you set these (or similar)
var url = Environment.GetEnvironmentVariable("SUPABASE_URL");
var key = Environment.GetEnvironmentVariable("SUPABASE_KEY");
await Supabase.Client.InitializeAsync(url, key);
// The Supabase Instance can be accessed at any time using:
// Supabase.Client.Instance {.Realtime|.Auth|etc.}
// For ease of readability we'll use this:
var instance = Supabase.Client.Instance;
// Interact with Supabase Storage
var storage = Supabase.Client.Instance.Storage
await storage.CreateBucket("testing")
var bucket = storage.From("testing");
var basePath = Path.GetDirectoryName(Assembly.GetExecutingAssembly().CodeBase).Replace("file:", "");
var imagePath = Path.Combine(basePath, "Assets", "supabase-csharp.png");
await bucket.Upload(imagePath, "supabase-csharp.png");
// If bucket is public, get url
bucket.GetPublicUrl("supabase-csharp.png");
// If bucket is private, generate url
await bucket.CreateSignedUrl("supabase-csharp.png", 3600));
// Download it!
await bucket.Download("supabase-csharp.png", Path.Combine(basePath, "testing-download.png"));
}
```
## Package made possible through the efforts of:
Join the ranks! See a problem? Help fix it!
<a href="https://github.com/supabase-community/storage-csharp/graphs/contributors">
<img src="https://contrib.rocks/image?repo=supabase-community/storage-csharp" />
</a>
Made with [contrib.rocks](https://contrib.rocks/preview?repo=supabase-community%storage-csharp).
## Contributing
We are more than happy to have contributions! Please submit a PR.