From d17633f0dc79e14deb6609432bc78475a89e3df1 Mon Sep 17 00:00:00 2001 From: Orestes Carracedo Date: Thu, 7 Jan 2016 21:06:27 +0100 Subject: [PATCH] docs(checklist): Add code sample for Tonic REPL npmjs.com shows a "Try it out" section with a link to try the package in the browser using Tonic, a browser REPL for node. The code that's shown there as an example can be customised as explained in the docs. --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 70cfb74..9506a70 100644 --- a/README.md +++ b/README.md @@ -53,6 +53,7 @@ Use [save-exact](https://docs.npmjs.com/misc/config#save-exact) NPM setting and or [fixpack](https://github.com/henrikjoreteg/fixpack) - [ ] write simple installation commands for your module - [ ] write "quick intro" example showing the main feature of your module +- [ ] include the code example in your `package.json` so it shows on when a user is testing your module on [Tonic](https://tonicdev.uservoice.com/knowledgebase/articles/765846-how-do-i-customize-the-example-for-my-npm-package) - [ ] add CONTRIBUTING.md file with clear guidelines how others can add new features or fix bugs in your module. [Atom editor](https://github.com/atom/atom/blob/master/CONTRIBUTING.md) and [lodash](https://github.com/lodash/lodash/blob/master/CONTRIBUTING.md) have excellent examples to follow. When GitHub finds a CONTRIBUTING.md file it [shows a message](https://github.com/blog/1184-contributing-guidelines) to anyone opening an issue.