Update Readme

DiscipleTools · Apr 24, 2024 · 793d951 · 793d951
1 parent ba35465
commit 793d951
Show file tree

Hide file tree

Showing 10 changed files with 11 additions and 107 deletions.
diff --git a/.rename.sh b/.rename.sh
diff --git a/README.md b/README.md
@@ -8,35 +8,25 @@ Disciple.Tools - Storage is intended to help manage connections with remote obje
 
 Provide the ability to store/retrieve all storage content within 3rd party object storage services; offering greater security.
 
-A detailed description of the typical usage flow for creating and using connections is provided below.
+## API
 
-## Usage
+See the [API Documentation](https://github.com/DiscipleTools/disciple-tools-storage/wiki/API) for more information.
+```php
+DT_Storage::get_file_url( string $key = '' )
+```
+```php
+DT_Storage::upload_file( string $key_prefix = '', array $upload = [], string $existing_key = '', array $args = [] )
+```
 
-#### Will Do
+## Setup
 
-- Create multiple object storage services connections.
-- Test supplied connection credentials.
-- Select default connection to be used for file storage within D.T theme.
-- Edit user profile pictures.
-
-#### Will Not Do
-
-- Add media content to comments.
-- Add media content to records.
-
-#### Typical Usage Flow
-
-- In order to use the new D.T Storage Plugin, ensure PHP version 8.1 or greater has been installed.
-
-![0](/documentation/readme/imgs/0.png)
-
-- Once D.T Storage Plugin has been installed, create a new connection.
+- Once D.T Storage Plugin has been installed, create a new connection. Go to WP Admin > Extensions (D.T) > Storage.
 
 ![1](/documentation/readme/imgs/1.png)
 
 - The following connection types (3rd Party Object Storage Services) are currently supported:
   - [AWS S3](https://aws.amazon.com/s3/)
-  - [BackBlaze](https://www.backblaze.com/)
+  - [BackBlaze](https://www.backblaze.com/) - Set our [BackBlaze setup notes](https://github.com/DiscipleTools/disciple-tools-storage/wiki/S3-Storage-Services#backblaze)
   - [MinIO](https://min.io/)
 
 
@@ -46,19 +36,6 @@ A detailed description of the typical usage flow for creating and using connecti
 
 > If no endpoint protocol scheme is specified; then https:// will be used.
 
-- Test connection, to ensure supplied credentials are valid.
-
-![3](/documentation/readme/imgs/3.png)
-
-- The following will be shown for failed connection tests.
-
-![4](/documentation/readme/imgs/4.png)
-
-> Some important things to note when working with Backblaze services:
->
-> - Ensure sufficient CORS permissions have been applied to target Backblaze bucket, as shown below:
-
-![5](/documentation/readme/imgs/5.png)
 
 - Once new connection has been validated and saved, navigate to Storage Settings section within D.T General Settings and select connection to be used for the default media storage within D.T.
 

diff --git a/documentation/community/starter-banners/README.md b/documentation/community/starter-banners/README.md
diff --git a/documentation/community/starter-banners/banner-blue-green.png b/documentation/community/starter-banners/banner-blue-green.png
diff --git a/documentation/community/starter-banners/banner-blue-orange.png b/documentation/community/starter-banners/banner-blue-orange.png
diff --git a/documentation/community/starter-banners/banner-green-blue.png b/documentation/community/starter-banners/banner-green-blue.png
diff --git a/documentation/community/starter-banners/banner-green-orange.png b/documentation/community/starter-banners/banner-green-orange.png
diff --git a/documentation/community/starter-banners/banner-orange-green.png b/documentation/community/starter-banners/banner-orange-green.png
diff --git a/documentation/community/starter-banners/banner-orange.png b/documentation/community/starter-banners/banner-orange.png
diff --git a/documentation/community/starter-readme.md b/documentation/community/starter-readme.md