instructively 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.
- package/README.md +39 -0
- package/index.js +21 -0
- package/package.json +27 -0
package/README.md
ADDED
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# Instructionly
|
|
2
|
+
|
|
3
|
+
A simple hello world Node.js package for npm.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install instructionly
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
```javascript
|
|
14
|
+
const instructionly = require('instructionly');
|
|
15
|
+
|
|
16
|
+
// Basic hello world
|
|
17
|
+
console.log(instructionly.hello()); // "Hello, World!"
|
|
18
|
+
|
|
19
|
+
// Hello with custom name
|
|
20
|
+
console.log(instructionly.helloWithName('John')); // "Hello, John!"
|
|
21
|
+
|
|
22
|
+
// Get package version
|
|
23
|
+
console.log(instructionly.getVersion()); // "1.0.0"
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## API
|
|
27
|
+
|
|
28
|
+
### `hello()`
|
|
29
|
+
Returns a simple "Hello, World!" message.
|
|
30
|
+
|
|
31
|
+
### `helloWithName(name)`
|
|
32
|
+
Returns a personalized hello message with the provided name.
|
|
33
|
+
|
|
34
|
+
### `getVersion()`
|
|
35
|
+
Returns the current version of the package.
|
|
36
|
+
|
|
37
|
+
## License
|
|
38
|
+
|
|
39
|
+
MIT
|
package/index.js
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Instructionly - A simple hello world Node.js package
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
function hello() {
|
|
6
|
+
return "Hello, World!";
|
|
7
|
+
}
|
|
8
|
+
|
|
9
|
+
function helloWithName(name) {
|
|
10
|
+
return `Hello, ${name}!`;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
function getVersion() {
|
|
14
|
+
return require('./package.json').version;
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
module.exports = {
|
|
18
|
+
hello,
|
|
19
|
+
helloWithName,
|
|
20
|
+
getVersion
|
|
21
|
+
};
|
package/package.json
ADDED
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "instructively",
|
|
3
|
+
"version": "1.0.2",
|
|
4
|
+
"description": "A simple hello world Node.js package",
|
|
5
|
+
"main": "index.js",
|
|
6
|
+
"scripts": {
|
|
7
|
+
"test": "echo \"Error: no test specified\" && exit 1",
|
|
8
|
+
"publish:npm": "npm publish",
|
|
9
|
+
"version:bump": "npm version patch --no-git-tag-version"
|
|
10
|
+
},
|
|
11
|
+
"keywords": [
|
|
12
|
+
"hello",
|
|
13
|
+
"world",
|
|
14
|
+
"node",
|
|
15
|
+
"npm"
|
|
16
|
+
],
|
|
17
|
+
"author": "Your Name",
|
|
18
|
+
"license": "MIT",
|
|
19
|
+
"repository": {
|
|
20
|
+
"type": "git",
|
|
21
|
+
"url": "git+https://github.com/yourusername/instructionly.git"
|
|
22
|
+
},
|
|
23
|
+
"bugs": {
|
|
24
|
+
"url": "https://github.com/yourusername/instructionly/issues"
|
|
25
|
+
},
|
|
26
|
+
"homepage": "https://github.com/yourusername/instructionly#readme"
|
|
27
|
+
}
|