Skip to content

Commit 3258994

Browse files
authored
Update README.md
1 parent d81d673 commit 3258994

1 file changed

Lines changed: 22 additions & 28 deletions

File tree

README.md

Lines changed: 22 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,30 @@
1-
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).
1+
# Pulse
22

3-
## Getting Started
3+
Built with **Next.js** and **Tiptap**, **Pulse** provides a clean and Medium-like blogging experience that allows you to easily create and share content. It offers an intuitive writing environment that enables writers to create with ease.
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-
```
16-
17-
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
18-
19-
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
20-
21-
This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
22-
23-
## Learn More
24-
25-
To learn more about Next.js, take a look at the following resources:
7+
* **Rich Text Editor:** A robust editor that supports various formatting options, including bold, italics, headers, lists, and code blocks.
8+
* **Content Publishing:** Simple and efficient process for creating, saving drafts, and publishing articles.
9+
* **Search and Discovery:** Functionality to search for articles and discover content from other authors.
10+
* **Commenting System:** A built-in system for readers to engage with published articles.
2611

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.
2912

30-
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
13+
## Project Setup
3114

32-
## Deploy on Vercel
15+
```bash
16+
# Clone the repository
17+
git clone https://github.com/Davidthecode/Pulse
18+
cd pulse
19+
npm install
20+
```
3321

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.
22+
```bash
23+
# Start server
24+
npm run dev
25+
```
3526

36-
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
27+
```bash
28+
# Build server
29+
npm run build
30+
```

0 commit comments

Comments
 (0)