Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
katherineoelsner committed Apr 11, 2021
1 parent 88dfada commit 78e13a1
Showing 1 changed file with 25 additions and 20 deletions.
45 changes: 25 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,39 @@
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).
# readme.so

## Getting Started
Readme.so is an online editor to help developers make readmes for their project.

First, run the development server:
Link to production site: [readme.so](https://readme.so)

```bash
npm run dev
# or
yarn dev
```
## Features

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
- Choose from list of sections to add to your readme
- Edit the contents of each section
- Drag and drop to rearrange sections
- Download your readme file

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

[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.js`.
Contributions are always welcome!

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.
See [CONTRIBUTING.md](/CONTRIBUTING.md) for ways to get started.

## Learn More
## Tech Stack

To learn more about Next.js, take a look at the following resources:
- [Next.js](https://nextjs.org/)
- [TailwindCSS](https://tailwindcss.com/)
- [dnd kit](https://dndkit.com/)
- [react-markdown](https://github.com/remarkjs/react-markdown)

- [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.
## Running the Dev Server

You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
To run the dev server, run `npm run dev` and navigate to `localhost:3000`

## Deploy on Vercel
## Feedback

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.
Feedback is appreciated! Reach out on [Twitter](https://twitter.com/katherinecodes) or submit a new issue!

Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
## License

[MIT](/LICENSE)

This readme was created with [readme.so](https://readme.so) :)

0 comments on commit 78e13a1

Please sign in to comment.