Readme.so
This is from readme.so
6/3/21
Project Title
A brief description of what this project does and who it's for
Usage/Examples
import Component from "my-project";
function App() {
return <Component />;
}
Optimizations
What optimizations did you make in your code? E.g. refactors, performance improvements, accessibility
Badges
Add badges from somewhere like: shields.io
Demo
Insert gif or link to demo
API Reference
Get all items
GET /api/items
| Parameter | Type | Description |
|---|---|---|
api_key | string | Required. Your API key |
Get item
GET /api/items/${id}
| Parameter | Type | Description |
|---|---|---|
id | string | Required. Id of item to fetch |
add(num1, num2)
Takes two numbers and returns the sum.
Environment Variables
To run this project, you will need to add the following environment variables to your .env file
API_KEY
ANOTHER_API_KEY
Features
- Light/dark mode toggle
- Live previews
- Fullscreen mode
- Cross platform
Installation
Install my-project with npm
npm install my-project
cd my-project
Lessons Learned
What did you learn while building this project? What challenges did you face and how did you overcome them?
Tech Stack
Client: React, Redux, TailwindCSS
Server: Node, Express