@virtru/hello-world-npm 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +24 -0
  2. package/index.js +7 -0
  3. package/package.json +8 -0
package/README.md ADDED
@@ -0,0 +1,24 @@
1
+ # hello-world-npm
2
+
3
+ This is a simple npm package that demonstrates the [GitHub Package Registry](https://github.com/features/package-registry).
4
+
5
+ ## Installation
6
+
7
+ Before installing, make sure to authenticate with GitHub Package Registry or using a `.npmrc` file. See "[Configuring npm for use with GitHub Package Registry](https://help.github.com/en/articles/configuring-npm-for-use-with-github-package-registry#authenticating-to-github-package-registry)."
8
+
9
+ `$ npm install @virtru/hello-world-npm`
10
+
11
+ Or add this package to your `package.json` file:
12
+
13
+ ```
14
+ "dependencies": {
15
+ "@virtru/hello-world-npm": "1.0.0"
16
+ }
17
+ ```
18
+
19
+ ## Usage
20
+
21
+ ```
22
+ const myPackage = require('@virtru/hello-world-npm');
23
+ myPackage.helloWorld();
24
+ ```
package/index.js ADDED
@@ -0,0 +1,7 @@
1
+ function helloWorld() {
2
+ console.log('Hello World!');
3
+ }
4
+
5
+ module.exports = {
6
+ helloWorld: helloWorld
7
+ }
package/package.json ADDED
@@ -0,0 +1,8 @@
1
+ {
2
+ "name": "@virtru/hello-world-npm",
3
+ "version": "1.0.2",
4
+ "repository": {
5
+ "type": "git",
6
+ "url": "https://github.com/virtru-corp/hello-world-npm.git"
7
+ }
8
+ }