From 80ddd46f00a3cb95af4cc8726f324c7f28a19b46 Mon Sep 17 00:00:00 2001 From: Abhay Ramesh Date: Sat, 16 Sep 2023 19:03:26 +0530 Subject: [PATCH] new readme --- README.md | 32 --------------------------- packages/next-s3-uploader/README.md | 34 ----------------------------- 2 files changed, 66 deletions(-) diff --git a/README.md b/README.md index 548dfda..8aafa94 100644 --- a/README.md +++ b/README.md @@ -11,38 +11,6 @@ **Next S3 Uploader** is a utility package for handling file uploads to Amazon S3 or compatible services like MinIO in a Next.js application. It simplifies the process of integrating secure and scalable cloud storage for your Next.js projects. -## Table of Contents - -- [Next.js S3 Uploader](#nextjs-s3-uploader) - - [Table of Contents](#table-of-contents) - - [Features](#features) - - [Installation](#installation) - - [Usage](#usage) - - [Prerequisites](#prerequisites) - - [Frontend (Nextjs App Directory)](#frontend-nextjs-app-directory) - - [API Route](#api-route) - - [API](#api) - - [`useS3FileUpload` Hook Options](#uses3fileupload-hook-options) - - [`uploadFiles` Function Options](#uploadfiles-function-options) - - [`uploadedFiles` Array Properties](#uploadedfiles-array-properties) - - [`reset` Function](#reset-function) - - [`createS3Client(config)`](#creates3clientconfig) - - [`generatePresignedUrls(s3Client, keys, bucket, prefix?)`](#generatepresignedurlss3client-keys-bucket-prefix) - - [Example Usage](#example-usage) - - [Allow Multiple File Uploads](#allow-multiple-file-uploads) - - [Limit Number of Uploaded Files](#limit-number-of-uploaded-files) - - [Set Maximum File Size](#set-maximum-file-size) - - [Custom Keys](#custom-keys) - - [Custom API Endpoint](#custom-api-endpoint) - - [AWS S3 Client](#aws-s3-client) - - [Non-AWS S3 Compatible Client (MinIO/Non-AWS)](#non-aws-s3-compatible-client-minionon-aws) - - [Basic File Upload](#basic-file-upload) - - [Authenticated Upload](#authenticated-upload) - - [Project-Specific Upload](#project-specific-upload) - - [Organization/Company File Storage](#organizationcompany-file-storage) - - [Contributing](#contributing) - - [License](#license) - ## Features - **Easy Integration**: Seamlessly integrate file upload functionality into your Next.js applications. diff --git a/packages/next-s3-uploader/README.md b/packages/next-s3-uploader/README.md index 548dfda..fde6b0d 100644 --- a/packages/next-s3-uploader/README.md +++ b/packages/next-s3-uploader/README.md @@ -1,7 +1,5 @@ # Next.js S3 Uploader -![Next.js S3 File Uploader](Next.js-S3-Uploader.png) - ![npm](https://img.shields.io/npm/dm/next-s3-uploader) ![npm](https://img.shields.io/npm/v/next-s3-uploader) ![GitHub](https://img.shields.io/github/license/abhay-ramesh/next-s3-uploader) @@ -11,38 +9,6 @@ **Next S3 Uploader** is a utility package for handling file uploads to Amazon S3 or compatible services like MinIO in a Next.js application. It simplifies the process of integrating secure and scalable cloud storage for your Next.js projects. -## Table of Contents - -- [Next.js S3 Uploader](#nextjs-s3-uploader) - - [Table of Contents](#table-of-contents) - - [Features](#features) - - [Installation](#installation) - - [Usage](#usage) - - [Prerequisites](#prerequisites) - - [Frontend (Nextjs App Directory)](#frontend-nextjs-app-directory) - - [API Route](#api-route) - - [API](#api) - - [`useS3FileUpload` Hook Options](#uses3fileupload-hook-options) - - [`uploadFiles` Function Options](#uploadfiles-function-options) - - [`uploadedFiles` Array Properties](#uploadedfiles-array-properties) - - [`reset` Function](#reset-function) - - [`createS3Client(config)`](#creates3clientconfig) - - [`generatePresignedUrls(s3Client, keys, bucket, prefix?)`](#generatepresignedurlss3client-keys-bucket-prefix) - - [Example Usage](#example-usage) - - [Allow Multiple File Uploads](#allow-multiple-file-uploads) - - [Limit Number of Uploaded Files](#limit-number-of-uploaded-files) - - [Set Maximum File Size](#set-maximum-file-size) - - [Custom Keys](#custom-keys) - - [Custom API Endpoint](#custom-api-endpoint) - - [AWS S3 Client](#aws-s3-client) - - [Non-AWS S3 Compatible Client (MinIO/Non-AWS)](#non-aws-s3-compatible-client-minionon-aws) - - [Basic File Upload](#basic-file-upload) - - [Authenticated Upload](#authenticated-upload) - - [Project-Specific Upload](#project-specific-upload) - - [Organization/Company File Storage](#organizationcompany-file-storage) - - [Contributing](#contributing) - - [License](#license) - ## Features - **Easy Integration**: Seamlessly integrate file upload functionality into your Next.js applications.