@mend-eicar/hello-world 1.0.0

package/README.md

@@ -0,0 +1,25 @@
+# Hello World
+
+A package that returns the `Hello world` string once you install it.
+
+## Local development
+
+### Building the package
+
+Navigate to this directory and run `npm link`.
+
+### Adding the package to your test application
+
+1. Create an empty `index.js` file in any location you wish, outside this directory.
+2. Run `npm link hello-world` from within that location.
+3. Edit the `index.js` file and place the following content inside:
+
+```js
+const { helloWorld } = require("hello-world");
+console.log(helloWorld());
+```
+
+4. Save the `index.js` file.
+5. Run `node index.js`.
+6. You should see `Hello world` displayed in the console.
+

package/index.js

@@ -0,0 +1,5 @@
+function helloWorld() {
+  return "Hello world";
+}
+
+module.exports = { helloWorld };

package/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "@mend-eicar/hello-world",
+  "version": "1.0.0",
+  "description": "A simple test package that returns the `Hello world` string once you install it.",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "Mend.io",
+  "license": "ISC"
+}