Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
fuma-nama committed May 12, 2023
1 parent e2dd6c6 commit 5208d24
Showing 1 changed file with 29 additions and 2 deletions.
31 changes: 29 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
> This project is just for fun, inspired by [Should I Deploy Today](https://shouldideploy.today/)
> This project is just for fun, not an actual hosting service/platform
![Nodeploy](document/nodeploy.png)

Expand All @@ -8,7 +8,9 @@

[Website](https://nodeploy-neon.vercel.app)
|
Documentation (coming soon)
[Documentation](https://nodeploy-neon.vercel.app/docs)
|
[Blog](https://nodeploy-neon.vercel.app/blog)

</div>

Expand All @@ -33,3 +35,28 @@ pnpm dev
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file.

#### Contribute to our Documentation

We have very less rules on what content you contributed:

1. No porn and racism content
2. No XSS attacks or dangerous content
3. Provide original article url if it is copied from somewhere

All documents is inside the `/content/docs` folder.

To create a new page in docs, you have to edit or create `meta.json` for each folder:

> Assume you have created first-page.mdx
```json
{
"title": "Name of the folder",
"pages": ["first-page", "second-page"]
}
```

#### Contribute to our Blog

Our blog is currently in Beta, You can still your own post there, we are welcome for any contributions

1 comment on commit 5208d24

@vercel
Copy link

@vercel vercel bot commented on 5208d24 May 12, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

nodeploy – ./

nodeploy-sonmoosans.vercel.app
nodeploy-git-main-sonmoosans.vercel.app
nodeploy-neon.vercel.app

Please sign in to comment.