Add 'from NPM' section and module docs
This commit is contained in:
parent
24f6fc59a7
commit
4bcfdb66e4
|
@ -0,0 +1,9 @@
|
|||
root = true
|
||||
|
||||
[*]
|
||||
indent_style = space
|
||||
indent_size = 2
|
||||
end_of_line = lf
|
||||
charset = utf-8
|
||||
trim_trailing_whitespace = false
|
||||
insert_final_newline = false
|
59
README.md
59
README.md
|
@ -2,9 +2,34 @@
|
|||
|
||||
A CLI application for interacting with ttm.sh.
|
||||
|
||||
## Installation
|
||||
*Although this is mainly a CLI application, there is also a [module](#3-module) that you can use in your own projects!*
|
||||
|
||||
<!-- TOC -->
|
||||
|
||||
- [1. Installation](#1-installation)
|
||||
- [1.1. From NPM](#11-from-npm)
|
||||
- [1.2. From Source](#12-from-source)
|
||||
- [2. Usage](#2-usage)
|
||||
- [2.1. Shorten](#21-shorten)
|
||||
- [2.2. Upload](#22-upload)
|
||||
- [3. Module](#3-module)
|
||||
- [4. Contributing](#4-contributing)
|
||||
|
||||
<!-- /TOC -->
|
||||
|
||||
## 1. Installation
|
||||
|
||||
### 1.1. From NPM
|
||||
|
||||
This method is recommended as there is less setup.
|
||||
|
||||
```sh
|
||||
npm install -g ttmsh
|
||||
# now you can use the command 'ttmsh'
|
||||
```
|
||||
|
||||
### 1.2. From Source
|
||||
|
||||
### From Source
|
||||
```sh
|
||||
git clone https://tildegit.org/jakew/ttmsh-cli.git
|
||||
cd ttmsh-cli
|
||||
|
@ -13,9 +38,9 @@ npm link
|
|||
# now you can use the command 'ttmsh' or 'node ./cli.js' or './cli.js' (only on nix)
|
||||
```
|
||||
|
||||
## Usage
|
||||
## 2. Usage
|
||||
|
||||
### Shorten
|
||||
### 2.1. Shorten
|
||||
|
||||
You can either include the URL in your command:
|
||||
|
||||
|
@ -34,7 +59,7 @@ jakew@tilde:~$ ttmsh shorten
|
|||
|
||||
*Note: You will be asked again if you pass in an invalid URL.*
|
||||
|
||||
### Upload
|
||||
### 2.2. Upload
|
||||
|
||||
Like with [shorten](#shorten), you can either include a file path in your command:
|
||||
|
||||
|
@ -51,6 +76,28 @@ jakew@tilde:~$ ttmsh upload
|
|||
√ https://ttm.sh/j0.txt
|
||||
```
|
||||
|
||||
## Contributing
|
||||
## 3. Module
|
||||
|
||||
You can also use the mini API wrapper in your application. Here's some example code on how to use it.
|
||||
|
||||
```js
|
||||
const ttmsh = require("ttmsh");
|
||||
|
||||
// upload a file to ttm.sh
|
||||
ttmsh.do("upload", "/path/to/file/to/upload.txt").then((result) => {
|
||||
console.log(`Here's your link: ${result}`);
|
||||
}).catch((err) => {
|
||||
console.error("Something went wrong.", err);
|
||||
});
|
||||
|
||||
// shorten a link with ttm.sh
|
||||
ttmsh.do("shorten", "https://example.com/this/is/a/long/url").then((result) => {
|
||||
console.log(`Here's your link: ${result}`);
|
||||
}).catch((err) => {
|
||||
console.error("Something went wrong.", err);
|
||||
});
|
||||
```
|
||||
|
||||
## 4. Contributing
|
||||
|
||||
I'd love for people to add in new features and improve on my current work so feel free to open a pull request!
|
Reference in New Issue