https://github.com/wayou/readme-template
a sample readme
https://github.com/wayou/readme-template
readme template
Last synced: 3 months ago
JSON representation
a sample readme
- Host: GitHub
- URL: https://github.com/wayou/readme-template
- Owner: wayou
- License: mit
- Created: 2019-03-31T15:49:27.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-03-31T16:29:37.000Z (over 6 years ago)
- Last Synced: 2025-03-16T17:25:14.342Z (7 months ago)
- Topics: readme, template
- Homepage:
- Size: 3.91 KB
- Stars: 0
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
PROJECT NAME
sub title goes here.
Key Features •
Getting Started •
Installing •
Usage •
Contributing •
License
## Key Features
* feature one
* feature two
- detail of feature two
- detail of feature two
* feature three
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
## Installing
npm:
```sh
$ npm i
```
yarn:
```sh
yarn add
```
## Usage
Import this to your project.
```js
import React from "react";
type Props = {
msg: string;
};
export function MyComponent({ msg }: Props) {
return (
{`Some sample code`}
{msg}
);
}
```
## Contributing
Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.
## License
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fwayou%2Freadme-template?ref=badge_large)