From cbb9d645bc4aa48d3e0f5b8ed668646f08620055 Mon Sep 17 00:00:00 2001
From: MarconLP <13001502+MarconLP@users.noreply.github.com>
Date: Wed, 26 Apr 2023 16:14:39 +0200
Subject: [PATCH] add README.md

---
 README.md | 80 +++++++++++++++++++++++++++++++++++++++++++------------
 1 file changed, 63 insertions(+), 17 deletions(-)

diff --git a/README.md b/README.md
index fba19ed..a603b0b 100644
--- a/README.md
+++ b/README.md
@@ -1,28 +1,74 @@
-# Create T3 App
+<p align="center">
+  <h3 align="center">Snapify</h3>
 
-This is a [T3 Stack](https://create.t3.gg/) project bootstrapped with `create-t3-app`.
+  <p align="center">
+    The self-hostable Loom alternative.
+    <br />
+    <a href="https://snapify.it"><strong>Learn more »</strong></a>
+  </p>
 
-## What's next? How do I make an app with this?
+<p align="center">
+  <a href='https://status.snapify.it'><img src='https://betteruptime.com/status-badges/v1/monitor/jgon.svg'  alt='Uptime'/></a>
+  <a href='https://github.com/MarconLP/snapify/stargazers'><img src='https://img.shields.io/github/stars/MarconLP/snapify'  alt='Github Stars'/></a>
+  <!--<a href="https://news.ycombinator.com/item?id=34279062"><img src="https://img.shields.io/badge/Hacker%20News-352-%23FF6600" alt="Hacker News"></a>-->
+  <a href="https://github.com/MarconLP/snapify/pulse"><img src="https://img.shields.io/github/commit-activity/m/MarconLP/snapify" alt="Commits-per-month"></a>
+  <a href="https://snapify.it"><img src="https://img.shields.io/badge/Pricing-Free-brightgreen" alt="Pricing"></a>
+  <a href="https://twitter.com/Marcon565"><img src="https://img.shields.io/twitter/follow/Marcon565?style=flat" alt='twitter'></a>
+</p>
 
-We try to keep this project as simple as possible, so you can start with just the scaffolding we set up for you, and add additional things later when they become necessary.
+<p align="center">
+  <a href="https://snapify.it">Website</a> - <a href="https://github.com/MarconLP/snapify/issues">Issue</a> - <a href="https://github.com/MarconLP/snapify/issues/new">Bug report</a>
+</p>
 
-If you are not familiar with the different technologies used in this project, please refer to the respective docs. If you still are in the wind, please join our [Discord](https://t3.gg/discord) and ask for help.
+## Snapify allows you to record and share recordings asynchronously
 
-- [Next.js](https://nextjs.org)
-- [NextAuth.js](https://next-auth.js.org)
-- [Prisma](https://prisma.io)
-- [Tailwind CSS](https://tailwindcss.com)
-- [tRPC](https://trpc.io)
+- Make unlimited recordings of your tab, desktop, and any application
+- Share recordings with anyone using a public link
+- Delete or un-list recordings after a specific timeframe
+- Upload and share existing to videos
 
-## Learn More
+## Development
 
-To learn more about the [T3 Stack](https://create.t3.gg/), take a look at the following resources:
+### Setup
 
-- [Documentation](https://create.t3.gg/)
-- [Learn the T3 Stack](https://create.t3.gg/en/faq#what-learning-resources-are-currently-available) — Check out these awesome tutorials
+1. Clone the repo into a public GitHub repository (or fork https://github.com/MarconLP/snapify/fork). If you plan to distribute the code, make sure to comply with our `LICENSE.md`.
 
-You can check out the [create-t3-app GitHub repository](https://github.com/t3-oss/create-t3-app) — your feedback and contributions are welcome!
+   ```sh
+   git clone https://github.com/MarconLP/snapify.git
+   ```
 
-## How do I deploy this?
+1. Go to the project folder
 
-Follow our deployment guides for [Vercel](https://create.t3.gg/en/deployment/vercel), [Netlify](https://create.t3.gg/en/deployment/netlify) and [Docker](https://create.t3.gg/en/deployment/docker) for more information.
+   ```sh
+   cd snapify
+   ```
+
+1. Install packages with yarn
+
+   ```sh
+   npm i
+   ```
+
+1. Set up your .env file
+    - Duplicate `.env.example` to `.env`
+    - Use `openssl rand -base64 32` to generate a key and add it under `NEXTAUTH_SECRET` in the .env file.
+    - Fill in the other variables
+
+
+1. Run (in development mode)
+
+   ```sh
+   npm run dev
+   ```
+
+## Deployment
+
+### Vercel
+
+[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FMarconLP%2Fsnapify)
+
+## Contributing
+Please see our contributing guide at `CONTRIBUTION.md`
+
+## License
+Distributed under the Sustainable Use License. See `LICENSE.md` for more information.
\ No newline at end of file