Skip to content

Commit 10c114e

Browse files
committed
Revise README to enhance clarity and detail; update features and usage instructions for email signature generator
1 parent 6b5514b commit 10c114e

File tree

1 file changed

+18
-29
lines changed

1 file changed

+18
-29
lines changed

README.md

Lines changed: 18 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,25 @@
1-
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).
1+
# Email Signature
22

3-
## Getting Started
3+
A simple email signature generator for your email client. Create a professional email signature for free with our generator.
44

5-
First, run the development server:
5+
## Features
66

7-
```bash
8-
npm run dev
9-
# or
10-
yarn dev
11-
# or
12-
pnpm dev
13-
# or
14-
bun dev
15-
```
7+
- Light & Dark Mode for signature output.
8+
- Dynamic elements based on user input.
9+
- Copy plain text or rich text signature to clipboard.
10+
- Your inputs will be saved in the browser's local storage.
11+
- Size of icons can be adjusted.
12+
- Ability to add banner and social media icons.
1613

17-
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
14+
## How to use
1815

19-
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
16+
1. Fill out the form with your information.
17+
2. Click on the "Copy" button.
18+
3. Paste the copied signature into your email client's signature settings.
2019

21-
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.
20+
## Technical Details
2221

23-
## Learn More
24-
25-
To learn more about Next.js, take a look at the following resources:
26-
27-
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
28-
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
29-
30-
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
31-
32-
## Deploy on Vercel
33-
34-
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.
35-
36-
Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
22+
- This project does not use any pre-made components.
23+
- This project uses functional programming patterns.
24+
- This project uses reusable components.
25+
- Responsive design for mobile and desktop.

0 commit comments

Comments
 (0)