Add README

brtvcl · Oct 13, 2022 · 03ee10d · 03ee10d
1 parent d359a7d
commit 03ee10d
Showing 1 changed file with 45 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,45 @@
+
+# Peerbox
+
+Secure file sharing with Peer-to-Peer transfer made with React + Tailwind. It uses WebRTC technology to send files between peers.
+
+## Install & Build
+Prerequisites
+- Install Node.js
+- Clone the repo
+
+📦 After cloning the repo install dependecies with 
+```sh 
+npm i
+```
+
+📡  To run development server use dev script
+```sh
+npm run dev
+```
+
+🔧 To build use build script
+```sh
+npm run build
+```
+
+## Demo
+
+🌐 https://hmi-concept.netlify.app/
+
+## Tech
+
+This project uses a number of open source projects to work properly:
+
+- [React.js] - JS library for crafting user interfaces
+- [Webpack] - Module bundler
+- [Tailwind] - A utility-first CSS framework
+- [Netlify] - Hosting service for static web apps
+- [WebRTC] - Real-time communication for the web
+- [PeerJS] - Easy to use wrapper for WebRTC  
+
+## License
+
+[MIT](https://choosealicense.com/licenses/mit/)
+
+