doc: adapt doc

This commit is contained in:
dancingCycle 2022-02-19 15:35:46 -05:00
parent 7d7da3c867
commit 86f390ba4c
1 changed files with 7 additions and 9 deletions

View File

@ -3,28 +3,26 @@
*
* SPDX-License-Identifier: GPL-3.0-or-later
*/
# axios
Client using axios library to send a HTTP GET request.
## Overview
This repository provides a command line interface service for Linux based operating system.
Download file using node.js inbuild packges.
## Preparation
Run the following command in your favorite GNU/Linux shell to install dependenies.
Run the following command in your favorite terminal to install dependenies.
```
npm i
```
## Development setup
Run the following command in your favorite GNU/Linux shell if you fancy log messages for debugging.
Run the following command in your favorite terminal if you fancy log messages for debugging.
```
export DEBUG=$DEBUG,axios
export DEBUG=$DEBUG,dload
```
Run the following command in your favorite GNU/Linux shell to start the service in development mode.
Run the following command in your favorite terminal to start the service in development mode.
```
npm run dev
```
## Production deployment
Run the following command in your favorite GNU/Linux shell to start the service for production mode.
Run the following command in your favorite terminal to start the service for production mode.
```
npm run start
```
## Links