diff --git a/README.md b/README.md index d883dc3..cb27192 100644 --- a/README.md +++ b/README.md @@ -11,12 +11,33 @@ This is [onedrive-cf-index](https://github.com/spencerwooo/onedrive-cf-index)'s ## Features - A TOTAL REFACTOR! +- Much more easier to deploy and manage. - Many more upcoming... +## Discussion + +Please go to our discussion forum for general questions, **issues are for bug reports and bug reports only.** + +[![GitHub Discussions](https://img.shields.io/github/discussions/spencerwooo/onedrive-vercel-index?color=0364B9&labelColor=24292F&logo=github&style=flat-square)](https://github.com/spencerwooo/onedrive-vercel-index/discussions) + ## Demo Available at: . +![demo](public/demo.png) + +## Deployment + +> Simplified version for now, will update for detailed documentations in due course. + +[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/git/external?repository-url=https%3A%2F%2Fgithub.com%2Fspencerwooo%2Fonedrive-vercel-index&env=REFRESH_TOKEN,ACCESS_TOKEN,CLIENT_SECRET&envDescription=Required%20API%20tokens%20for%20this%20project.&project-name=onedrive-vercel-index&repo-name=onedrive-vercel-index&demo-title=onedrive-vercel-index&demo-description=Probably%20the%20best%20looking%20OneDrive%20Index%20around!%20Powered%20by%20Vercel%20and%20Next.js.&demo-url=http%3A%2F%2Fonedrive-vercel-index.vercel.app&demo-image=https%3A%2F%2Fraw.githubusercontent.com%2Fspencerwooo%2Fonedrive-vercel-index%2Fmain%2Fpublic%2Fdemo.png) + +- Use the button above to deploy the project to Vercel. Vercel will automatically fork and clone the project to your GitHub account. +- Define environment variables inside Vercel: `REFRESH_TOKEN`, `ACCESS_TOKEN`, `CLIENT_SECRET`. +- Finally, change configuration file [`config/api.json`](config/api.json) and [`config/site.json`](config/site.json) according to your configs. + +The authentication tokens and variables are the same as what you configured in the [`onedrive-cf-index`](https://github.com/spencerwooo/onedrive-cf-index) project. Detailed documentations can also be found there (for now). This project is at its early stages, for discussions *please, please, please* post to the [discussion forum](https://github.com/spencerwooo/onedrive-vercel-index/discussions). + --- **onedrive-vercel-index** ©Spencer Woo. Released under the MIT License. diff --git a/public/demo.png b/public/demo.png new file mode 100644 index 0000000..84c6485 Binary files /dev/null and b/public/demo.png differ diff --git a/public/vercel.svg b/public/vercel.svg deleted file mode 100644 index fbf0e25..0000000 --- a/public/vercel.svg +++ /dev/null @@ -1,4 +0,0 @@ - - - \ No newline at end of file