Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
yoshikouki committed Dec 23, 2021
1 parent 52aeabc commit a7646c1
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 4 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ command:

path:
@echo "\nensure to set deno to PATH."
@echo '$$ export PATH=\"~/.deno/bin:$$PATH\" >> ~/.zshrc'
@echo '$$ export PATH="~/.deno/bin:$$PATH" >> ~/.zshrc'

test:
deno test $(DENO_OPTIONS)
52 changes: 49 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,67 @@

Require to setup deno.

https://deno.land/
https://deno.land/manual@main/getting_started/installation

```sh
$ git clone https://github.com/yoshikouki/tw.git && cd tw && make install
#> ✅ Successfully installed tw
#> /Users/yoshikouki/.deno/bin/tw
#>
#> ensure to set deno to PATH.
#> $ export PATH="~/.deno/bin:$PATH" >> ~/.zshrc

$ export PATH="~/.deno/bin:$PATH" >> ~/.zshrc
```

or

```
# one liner install command (WIP)
```

## Setup

### Using trial keys (unsafe)

```
$ tw
#> [WARNING] Your consumer_key or consumer_secret for Twitter API is not found.
#> Sure to use trial key what is not secure because it is published.
#> See README for details.
#> https://github.com/yoshikouki/tw
#>
#> Use the trial key? [y/N]
```

### Using Your keys

Get consumer_key and consumer_secret for Twitter API.
And ensure to enable OAuth 1.0a for user authentication settings.

https://developer.twitter.com/en/docs/authentication/oauth-1-0a/api-key-and-secret

```
$ CONSUMER_KEY=consumer_key CONSUMER_SECRET=consumer_secret tw
```

supported for .env file

```
$ mv .env-sample .env # and update
$ tw
```

## Usage

### tweet #WIP
### tweet

```sh
$ tw tweet by tw!!1
```

### Check Timeline #WIP
### Check Timeline

```sh
$ tw -l
Expand Down

0 comments on commit a7646c1

Please sign in to comment.