Skip to content

alex-cory/readme-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 

Repository files navigation


Project Title


🔥 One liner description of what your repo does


npm i use-http


One to two paragraph project descrption of what it does. Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged.

(example gif demo of what your project does)

Features

  • it does this
  • it also does that

Usage

⚠️ Examples click me

Some Example

Potentially a short summary below, but not 100% necessary.

This would be
some code block

Another Example

Potentially a short summary below, but not 100% necessary here either.

This would be
some other block
of code

Todos

I like to put these here because 1. it helps me remember what I need to do, and 2. sometimes people might want to contribute and this gives them very clear todos. 😊

  • tests yarn test
  • github pages - make some docs. I like docsify, but there's also docusaurus
  • publish to NPM yarn publish
  • continuous integration (awesome continuous integration list)
  • make more examples on codesandbox
  • document in a different language
  • badges awesome list 1, awesome list 2
  • add keywords to package.json for google searchability
  • add "topics" to repo by clicking the "Manage topics" button at the top of your repo page. (similar to keywords)
  • add Social Preview so when you share on social media it will not show your github profile picture (go to Settings tab)
  • check out the awesome readme list to see others
  • checkout this example readme I really like it
  • make a cool logo

About

🔥The most awesome README template out there

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published