Skip to content

Commit

Permalink
feat: Readme updated
Browse files Browse the repository at this point in the history
  • Loading branch information
Yash committed Sep 15, 2024
1 parent 65fec51 commit 63cbc03
Showing 1 changed file with 43 additions and 22 deletions.
65 changes: 43 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,57 @@
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
# SnapCut: Screenshot Editor

## Getting Started
## 🖼️✨ Transform ordinary screenshots into aesthetic masterpieces

🚀 Built with Next.js, TypeScript, and Tailwind CSS 🎨

---

## Features

- 📸 AI-powered background generation
- 🎭 Custom shadow and corner effects
- 🖥️ 8K resolution support
- 📱 Responsive design with Tailwind
- ⚡ Server-side rendering for optimal performance
- 🛡️ Type-safe development with TypeScript

## Tech Stack

- [Next.js](https://nextjs.org/)
- [TypeScript](https://www.typescriptlang.org/)
- [Tailwind CSS](https://tailwindcss.com/)
- [Sharp](https://sharp.pixelplumbing.com/)

First, run the development server:
## Getting Started

```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
```
# Clone the repository
git clone https://github.com/yourusername/snapcut.git

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
# Navigate to the project directory
cd snapcut

You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
# Install dependencies
pnpm install # or npm install

This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
# Run the development server
pnpm dev # or npm run dev
```

## Learn More
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

## Contributing

To learn more about Next.js, take a look at the following resources:
We welcome contributions! Please see our [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to submit pull requests.

- [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.
## License

You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.

## Deploy on Vercel
---

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.
Elevate your visual content with SnapCut - where screenshots meet style. ✨

Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
```
@YashMahajan
```

0 comments on commit 63cbc03

Please sign in to comment.