Skip to content

Papermark is the open-source DocSend alternative and secure data rooms with built-in analytics and custom domains.

update README

Marc Seitze5ba83c777d3
diff --git a/README.md b/README.md
index 965a1228..f31d79be 100644
--- a/README.md
+++ b/README.md
@@ -1,38 +1,51 @@
-This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
+<div align="center">
+ <h1 align="center">Papermark</h1>
+ <h5>Open-source alternative to DocSend</h5>
+</div>
+
+<div align="center">
+ <a href="https://papermark.io">papermark.io</a>
+</div>
+<br/>
-## Getting Started
+Papermark is an open-source document sharing alternative to Docsend with built-in analytics. Built with [Vercel Storage](http://vercel.com/storage) and [Vercel Edge Functions](http://vercel.com/edge).
+
+This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
-First, run the development server:
+## Features
-```bash
-npm run dev
-# or
-yarn dev
-# or
-pnpm dev
-```
+- **Shareable Links:** Share your document securely by sending a link
+- **Analytics:** Get analytics via link view tracking and soon page-by-page analytics
+- **Self-hosted, open-source:** Host it yourself and hack on it
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+<br/>
-You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file.
+![](public/papermark.png)
-[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.ts`.
+## Tech Stack
-The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
+- [Next.js](https://nextjs.org/) – framework
+- [Typescript](https://www.typescriptlang.org/) – language
+- [Tailwind](https://tailwindcss.com/) – styling
+- [Prisma](https://prisma.io) - orm
+- [Vercel Blob](https://vercel.com/storage/blob) - blob storage
+- [Vercel Postgres](https://vercel.com/storage/postgres) - database
+- [NextAuth.js](https://next-auth.js.org/) – auth
+- [Vercel](https://vercel.com/) – hosting
-This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
+## Deploy your own
-## Learn More
+All you need is a Vercel account and access to Vercel Storage (_Blob_ and _Postgres_). Click the
+button below to clone and deploy:
-To learn more about Next.js, take a look at the following resources:
+[![Deploy with Vercel](https://vercel.com/button)](#)
-- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
-- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+## Contributing
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
+Papermark is an open-source project and we welcome contributions from the community.
-## Deploy on Vercel
+## Inspiration
-The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+...and friends
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
+- [Dub](https://github.com/steven-tey/dub) - An open-source link shortener SaaS with built-in analytics + free custom domains