From 4a2c5755662f441352a089c72fc8302db5579958 Mon Sep 17 00:00:00 2001
From: mbaharip <62494292+mbahArip@users.noreply.github.com>
Date: Sun, 26 Jan 2025 03:46:19 +0700
Subject: [PATCH] chore: update readme
---
CHANGELOG.md | 0
README.md | 39 ++++++++++++++++++++++++---------------
2 files changed, 24 insertions(+), 15 deletions(-)
delete mode 100644 CHANGELOG.md
diff --git a/CHANGELOG.md b/CHANGELOG.md
deleted file mode 100644
index e69de29..0000000
diff --git a/README.md b/README.md
index c816f7c..581f98c 100644
--- a/README.md
+++ b/README.md
@@ -3,20 +3,15 @@
Demo Site
·
- Deploy / Version Upgrade Guide
+ Deploy / Version Upgrade Guide
·
- FAQ
+ How to Deploy (Youtube)
-
-
+
+
-> ![NOTE]
-> All thing left is configurator, and the site is ready to be deployed! (Will remove this note when code ready to be merged)
-
----
-
## Table of Contents
@@ -27,6 +22,8 @@
- [Known Issues](#known-issues)
- [File size limit](#file-size-limit)
- [No support for Google Docs, Sheets, and Slides](#no-support-for-google-docs-sheets-and-slides)
+ - [No support for Shortcut](#no-support-for-shortcut)
+ - [Encryption cause error](#encryption-cause-error)
- [Can't seek on audio and video preview](#cant-seek-on-audio-and-video-preview)
- [Shared Drive is not supported](#shared-drive-is-not-supported)
- [Might be Implemented](#might-be-implemented)
@@ -63,8 +60,8 @@ _Price are converted to IDR, since it's easier for me to compare this using my o
| **Dropbox**\* | 2GB | 2TB | ~191k IDR
~159k IDR | 10.5GB / 1k / mo
12.5GB / 1k / yr | O |
| **MEGA** | **20GB** | 2TB | ~174k IDR
~145k IDR | 11.5GB / 1k / mo
13.8GB / 1k / yr | O |
-\* Price are in USD, and there are no regional price for IDR
-\*\* There are no 2TB plan
+> \* Price are in USD, and there are no regional price for IDR \
+> \*\* There are no 2TB plan
By using this data, I picked Google Drive instead other service.
I know there are a lot of people selling cheap education account especially for Google Drive and Onedrive, but most of the time those account doesn't last long.
@@ -81,11 +78,12 @@ I know there are a lot of people selling cheap education account especially for
- Document preview
- Code / Text / Markdown preview
- Manga preview (cbz)
+- **Embed media**, embed media like video or audio to your site
- **File search**, search by the file or folder name
- **Direct download**, download directly via API route instead of google drive link ( Size limit can be adjusted )
- **Raw file link**, embed your media files
- **Light/Dark mode**, choose your side!
-- **Customizable Theme**, we are using `shadcn/ui` now! you can customize your site [https;//drive-demo.mbaharip.com/deploy#theme]
+- **Customizable Theme**, we are using `shadcn/ui` now! you can customize your site with the theme you like
- **Links**, add social, or information link on the navbar
- **Sponsors**, using this for thing for community? add a sponsor / donate button on your navbar!
@@ -93,6 +91,7 @@ I know there are a lot of people selling cheap education account especially for
### File size limit
+> [!INFO]
> This only apply if `maxFileSize` is enabled / more than 0
You need to set the file sharing permission to `Anyone with the link can view` on the root folder.
@@ -101,13 +100,23 @@ You need to set the file sharing permission to `Anyone with the link can view` o
The download link will be redirected if the file you're trying to download is bigger than the `maxFileSize`, and most of platform are limiting the response body size (ex: Vercel limit is 4MB).
If you don't set the permission, people can't access or download the file.
-This will expose the file ID, and people can access the file directly from Google Drive.
-But it only apply to the file, and they can't see or browse the folder directly from Google Drive.
+> [!WARNING]
+> This will **expose the file ID**
+> While they can view the file directly from Google Drive, they can't see or browse the folder that contains the file from Google Drive.
### No support for Google Docs, Sheets, and Slides
For now, I don't have any plan to implement this, because I think it's not necessary.
+### No support for Shortcut
+
+While I think it's important, I don't have any plan to implement this for now.
+
+### ~Encryption cause error~
+
+~~It seems the configurator are generating wrong encrypted folder ID, so it will cause error when you try to access the folder.~~
+Should be fixed on v2.0.4, waiting for feedback / confirmation
+
### ~~Can't seek on audio and video preview~~
~~It looks like you can't seek the audio and video preview, so you need to listen / watch from the beginning.~~
@@ -162,7 +171,7 @@ It might need a database, but idk if I can implement it without the need of data
Want to add new feature or improve the existing one? or you find a bug and fixed it yourself?
- Please check the issue tab first to see if someone already reporting a bug, or if you want to check any new feature / enhancement that not yet implemented
-- Use code base from `v2` branch instead of the `main`, since it was made for development on current version
+- Use code base from the latest version branch instead of the `main`, since it was made for development on current version
- Create a Pull Request, and wait for me checking your code
## Support and Donations