mirror of
https://github.com/FranP-code/Show-multiplication-tables-CLI-Tool.git
synced 2025-10-12 23:52:32 +00:00
Readme added
This commit is contained in:
@@ -1,11 +1,11 @@
|
||||
{
|
||||
"name": "mostrar-tablas-de-multiplicar-cli",
|
||||
"name": "show-multiplication-tables-cli-tool",
|
||||
"version": "1.0.0",
|
||||
"description": "",
|
||||
"main": "app.js",
|
||||
"scripts": {
|
||||
"api": "nodemon ./API/returnMultiplicationTables.js",
|
||||
"game": "node app.js"
|
||||
"tool": "node app.js"
|
||||
},
|
||||
"author": "FranP-Code",
|
||||
"license": "ISC",
|
||||
|
||||
64
readme.MD
Normal file
64
readme.MD
Normal file
@@ -0,0 +1,64 @@
|
||||
# Show multiplication tables CLI Tool
|
||||
|
||||
## Description
|
||||
|
||||
With this tool you can see in your console the multiplication tables of every number.
|
||||
|
||||
## Functions of the tool
|
||||
|
||||
1. Define the number to generate the tables
|
||||
2. Select from what number start in the tables
|
||||
3. Limit the quantity of tables to return
|
||||
|
||||
## Dependencies
|
||||
|
||||
- Git
|
||||
- npm
|
||||
- Inquirer.js
|
||||
- colors.js
|
||||
- axios
|
||||
|
||||
### How to install npm dependencies
|
||||
|
||||
- Run this command in the tool folder:
|
||||
```
|
||||
npm install
|
||||
```
|
||||
|
||||
## How to use
|
||||
|
||||
1. Clone the repository with this command:
|
||||
```
|
||||
git clone https://github.com/FranP-code/show-multiplication-tables-cli-tool.git
|
||||
```
|
||||
|
||||
2. Go to the tool folder with this command:
|
||||
```
|
||||
cd ./show-multiplication-tables-cli-tool
|
||||
```
|
||||
|
||||
3. Install the npm Dependencies
|
||||
```
|
||||
npm install
|
||||
```
|
||||
|
||||
4. Use it.
|
||||
|
||||
```
|
||||
node ./app.js
|
||||
```
|
||||
|
||||
or...
|
||||
|
||||
```
|
||||
npm run tool
|
||||
```
|
||||
|
||||
## Aditionals
|
||||
|
||||
Additionally, I developed an API for make the processing of the multiplication tables.
|
||||
|
||||
Obviously, don't makes sense make an API for that simple task, but I wanted to try develop one with Node.js
|
||||
|
||||
|
||||
I hope you enjoy it! 🙌
|
||||
Reference in New Issue
Block a user