supabase/storage-js

Provide a quick-start guide in the README

mircea-pavel-anton opened this issue ยท 4 comments

Improve documentation

Link

README

Describe the problem

In other supabase components, such as postgrest-js, realtime-js and gotrue-js, there are short quick start sections in the readme to show you how you can get up and running without using the supabase-js package.

Describe the improvement

Add a few code snippets that will document a quick start procedure.

I noticed this because I have to use this module in my project now and I had to check the source code to see how I can create a new SupabaseStorageClient. Not that it is the end of the world, but it would be nice to have a quick guide in the readme like the other modules do.

I may take a look at it and provide some code samples and a PR this week.

๐ŸŽ‰ This issue has been resolved in version 1.7.1 ๐ŸŽ‰

The release is available on:

Your semantic-release bot ๐Ÿ“ฆ๐Ÿš€

๐ŸŽ‰ This issue has been resolved in version 1.8.0-next.1 ๐ŸŽ‰

The release is available on:

Your semantic-release bot ๐Ÿ“ฆ๐Ÿš€

๐ŸŽ‰ This issue has been resolved in version 2.0.0-rc.1 ๐ŸŽ‰

The release is available on:

Your semantic-release bot ๐Ÿ“ฆ๐Ÿš€