Skip to content
This repository was archived by the owner on Dec 4, 2023. It is now read-only.

Commit 2370ef4

Browse files
authored
v1.0.2
A small release updating the README.
1 parent d1bdf98 commit 2370ef4

3 files changed

Lines changed: 93 additions & 61 deletions

File tree

README.md

Lines changed: 90 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,15 @@
11
<p align="center">
2-
<img src="https://easyscriptjs.github.io/images/cover.png">
2+
<img src="https://easyscriptjs.github.io/images/cover.png" height="368">
33
</p>
44

55
<h1 align="center">Easy Script</h1>
6+
7+
<p align="center">
8+
<img alt="Lastest Release" src="https://img.shields.io/github/v/release/easyscriptjs/easyscript?style=for-the-badge">
9+
<img alt="GitHub Issues" src="https://img.shields.io/github/issues-raw/easyscriptjs/easyscript?label=Issues&style=for-the-badge">
10+
<img alt="GitHub Pull Requests" src="https://img.shields.io/github/issues-pr-raw/easyscriptjs/easyscript?label=Pull%20Requests&style=for-the-badge">
11+
</p>
12+
613
<p align="center">Easy Script is a npm package which makes coding in JavaScript easy!</p>
714

815
## Usage
@@ -19,7 +26,7 @@ npm install easyscriptjs
1926

2027
```js
2128
// List all of the modules you want to use in the brackets
22-
// Example: { log, print }
29+
// Example: { flip, print, random }
2330
const { print } = require("easyscriptjs");
2431
```
2532

@@ -34,73 +41,98 @@ print("Hello World");
3441
## Modules
3542

3643
### flip
37-
- The flip module is a module which flips a coin and returns `heads` or `tails`.
38-
- Example:
39-
```js
40-
const { flip } = require("easyscriptjs");
44+
The flip module is a module which flips a coin and returns `heads` or `tails`.
4145

42-
const result = flip();
46+
**Example**
4347

44-
console.log(result);
45-
```
48+
```js
49+
// Import module
50+
const { flip } = require("easyscriptjs");
51+
52+
// Generate a result
53+
const result = flip();
54+
55+
// Log result to console
56+
console.log(result);
57+
```
4658

4759
### log
48-
- The log module lets you use a shortened version of `console.log` in Node.js. It also supports variables as well.
49-
- Example with text:
50-
```js
51-
const { log } = require("easyscriptjs");
60+
The log module lets you use a shortened version of `console.log` in Node.js. It also supports variables as well.
61+
62+
**Examples**
5263

53-
// Logs the text to console
54-
log("Hello World");
55-
```
56-
- Example with a variable:
57-
```js
58-
const { log } = require("easyscriptjs");
64+
- With text:
65+
```js
66+
// Import module
67+
const { log } = require("easyscriptjs");
5968

60-
const text = "Hello World";
69+
// Logs text to console
70+
log("Hello World");
71+
```
6172

62-
// Logs the text from the variable to console
63-
log(text);
64-
```
73+
- With a variable:
74+
```js
75+
// Import module
76+
const { log } = require("easyscriptjs");
77+
78+
// Text to be logged
79+
const text = "Hello World";
80+
81+
// Logs the "text" variable to console
82+
log(text);
83+
```
6584

6685
### print
67-
- The print module allows you to use `console.log` as if it was Python. It also supports variables as well.
68-
- Example with text:
69-
```js
70-
const { print } = require("easyscriptjs");
86+
The print module allows you to use `console.log` as if it was Python. It also supports variables as well.
87+
88+
**Examples**
89+
90+
- With text:
91+
```js
92+
// Import module
93+
const { print } = require("easyscriptjs");
7194

72-
// Logs the text to console
73-
print("Hello World");
74-
```
75-
- Example with a variable:
76-
```js
77-
const { print } = require("easyscriptjs");
95+
// Logs the text to console
96+
print("Hello World");
97+
```
7898

79-
const text = "Hello World";
99+
- With a variable:
100+
```js
101+
// Import module
102+
const { print } = require("easyscriptjs");
80103

81-
// Logs the text from the variable to console
82-
print(text);
83-
```
104+
// Text to be logged
105+
const text = "Hello World";
106+
107+
// Logs the "text" variable to console
108+
print(text);
109+
```
84110

85111
### random
86-
- The random module allows you to generate a random number. By default the highest number is `100`, but you can change that by specifying a number in the function. The highest number supported is `2,147,483,647` as that is the 32-bit integer limit.
87-
- Example without input:
88-
```js
89-
const { random } = require("easyscriptjs");
90-
91-
// Generates a result from 1-100
92-
const result = random();
93-
94-
// Generates a random number from 1 to 100 (the default)
95-
console.log(result);
96-
```
97-
- Example with input:
98-
```js
99-
const { random } = require("easyscriptjs");
100-
101-
// Generates a random number from 1 to 30
102-
const result = random(30);
103-
104-
// Logs the result to console
105-
console.log(result);
106-
```
112+
The random module allows you to generate a random number. By default the highest number is `100`, but you can change that by specifying a number in the function. The highest number supported is `2,147,483,647` as that is the 32-bit integer limit.
113+
114+
**Examples**
115+
116+
- Without input:
117+
```js
118+
// Import module
119+
const { random } = require("easyscriptjs");
120+
121+
// Generates a result from 1-100
122+
const result = random();
123+
124+
// Generates a random number from 1 to 100 (the default)
125+
console.log(result);
126+
```
127+
128+
- Example with input:
129+
```js
130+
// Import module
131+
const { random } = require("easyscriptjs");
132+
133+
// Generates a random number from 1 to 30
134+
const result = random(30);
135+
136+
// Logs the result to console
137+
console.log(result);
138+
```

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "easyscriptjs",
3-
"version": "1.0.1",
3+
"version": "1.0.2",
44
"description": "Easy Script is a npm package which makes coding in JavaScript easy!",
55
"main": "src/index.js",
66
"scripts": {},

0 commit comments

Comments
 (0)