diff --git a/README.md b/README.md index 3ad433a..a263a5f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,12 @@ # react-dropzone-vv -react-dropzone-vv is a simple React hook that creates a drag-and-drop zone for files. Simple, yet customizable by the user. +react-dropzone-vv is a package for React to create drag-and-drop zones for files. Simple, yet customizable by the user. + +## Document + +[Document](https://react-dropzone-vv.yosidev.com/) + +## Links [github](https://github.com/yosipy/react-dropzone-vv), [npm](https://www.npmjs.com/package/react-dropzone-vv) diff --git a/docker-compose.yml b/docker-compose.yml index df00913..cfa5060 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -6,7 +6,7 @@ services: context: . dockerfile: ./Dockerfile command: > - npm run dev -- --host 0.0.0.0 + npm run docs:dev -- --host 0.0.0.0 working_dir: /app ports: - 5173:5173 diff --git a/docs/index.md b/docs/index.md index 53b0505..65ca3fd 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,8 +4,7 @@ layout: home hero: name: "react-dropzone-vv" - text: "" - tagline: "react-dropzone-vv is a simple React hook that creates a drag-and-drop zone for files. Simple, yet customizable by the user." + tagline: "react-dropzone-vv is a package for React to create drag-and-drop zones for files. Simple, yet customizable by the user." actions: - theme: brand text: What is react-dropzone-vv @@ -19,11 +18,14 @@ hero: features: - title: Lightweight - details: Small package just to create drag-and-drop zones - icon: 📃 - - title: It's used in my application - details: ImgRoller is a free website that allows you to resize and compress multiple images at once. + details: Small package just to create drag-and-drop zones. + icon: 🍏 + - title: Track record + details: It's used in our application. ImgRoller is a free website that allows you to resize and compress multiple images at once. icon: src: /imgroller.svg link: https://yosidev.com/tools/imgroller/en/ + - title: TypeScript support + details: react-dropzone-vv is written in TypeScript. + icon: ✨ --- diff --git a/docs/introduction/what-is-react-dropzone-vv.md b/docs/introduction/what-is-react-dropzone-vv.md index ac963dd..e9ab4a7 100644 --- a/docs/introduction/what-is-react-dropzone-vv.md +++ b/docs/introduction/what-is-react-dropzone-vv.md @@ -5,7 +5,7 @@ It is simple yet user-customizable. A similar Package, [react-dropzone](https://github.com/react-dropzone/react-dropzone), is well known. However, as of 2024, it has been out of date for about two years. -So I did not use react-dropzone for my own products, and used components I created myself. The created component is published as react-dropzone-vv. +So I did not use react-dropzone for our own products, and used components I created myself. The created component is published as react-dropzone-vv. react-dropzone-vv is heavily influenced by react-dropzone, but instead of Forking the repository, we rewrote it from scratch. The purpose of react-dropzone-vv is to provide a simple and easy-to-use HTML5-compliant drag-and-drop zone for files. diff --git a/docs/imgroller.svg b/docs/public/imgroller.svg similarity index 100% rename from docs/imgroller.svg rename to docs/public/imgroller.svg diff --git a/package.json b/package.json index 55e3fa2..3dbe992 100644 --- a/package.json +++ b/package.json @@ -4,7 +4,7 @@ "author": { "name": "yosipy" }, - "version": "0.1.4", + "version": "0.1.5", "keywords": [ "dropzone", "drag and drop", @@ -35,13 +35,13 @@ "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0", "preview": "vite preview", "test": "vitest", - "docs:dev": "vitepress dev docs --host 0.0.0.0", + "docs:dev": "vitepress dev docs", "docs:build": "vitepress build docs", "docs:preview": "vitepress preview docs" }, "peerDependencies": { - "react": "^18.3.1", - "react-dom": "^18.3.1" + "react": "17.x || 18.x", + "react-dom": "17.x || 18.x" }, "devDependencies": { "@types/react": "^18.3.3",