Package: plotlab
Best-README-TemplateAn awesome README template to jumpstart your projects!Explore the docs »View Demo·Report Bug·Request FeatureTable of ContentsAbout The ProjectBuilt WithGetting StartedPrerequisitesInstallationUsageRoadmapContributingLicenseContactAcknowledgmentsAbout The ProjectThere are many great README templates available on GitHub; however, I didn't find one that really suited my needs so I created this enhanced one. I want to create a README template so amazing that it'll be the last one you ever need -- I think this is it.Here's why:Your time should be focused on creating something amazing. A project that solves a problem and helps othersYou shouldn't be doing the same tasks over and over like creating a README from scratchYou should implement DRY principles to the rest of your life :smile:Of course, no one template will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue. Thanks to all the people have contributed to expanding this template!Use theBLANK_README.mdto get started.(back to top)Built WithThis section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.Next.jsReact.jsVue.jsAngularSvelteLaravelBootstrapJQuery(back to top)Getting StartedThis is an example of how you may give instructions on setting up your project locally.
To get a local copy up and running follow these simple example steps.PrerequisitesThis is an example of how to list things you need to use the software and how to install them.npmnpminstallnpm@latest-gInstallationBelow is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.Get a free API Key athttps://example.comClone the repogitclonehttps://github.com/your_username_/Project-Name.gitInstall NPM packagesnpminstallEnter your API inconfig.jsconstAPI_KEY='ENTER YOUR API';(back to top)UsageUse this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.For more examples, please refer to theDocumentation(back to top)RoadmapAdd ChangelogAdd back to top linksAdd Additional Templates w/ ExamplesAdd "components" document to easily copy & paste sections of the readmeMulti-language SupportChineseSpanishSee theopen issuesfor a full list of proposed features (and known issues).(back to top)ContributingContributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make aregreatly appreciated.If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!Fork the ProjectCreate your Feature Branch (git checkout -b feature/AmazingFeature)Commit your Changes (git commit -m 'Add some AmazingFeature')Push to the Branch (git push origin feature/AmazingFeature)Open a Pull Request(back to top)LicenseDistributed under the MIT License. SeeLICENSE.txtfor more information.(back to top)ContactYour Name -@your_twitter-email@example.comProject Link:https://github.com/your_username/repo_name(back to top)AcknowledgmentsUse this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!Choose an Open Source LicenseGitHub Emoji Cheat SheetMalven's Flexbox CheatsheetMalven's Grid CheatsheetImg ShieldsGitHub PagesFont AwesomeReact Icons(back to top)