Skip to content

Commit

Permalink
Merge pull request #6 from harakeishi/add_example
Browse files Browse the repository at this point in the history
Add example
  • Loading branch information
harakeishi authored Oct 31, 2022
2 parents b157058 + d624a44 commit 662a83b
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ This command is used to view `tbls` information stored in github, e.g. in a term
- [License](#license)

# DEMO
![image](https://user-images.githubusercontent.com/44335168/198061401-44dfb274-2d2a-43fe-aef2-e6a120cb48b8.gif)
![image](https://user-images.githubusercontent.com/44335168/199011337-796428e4-88d7-4d40-983d-eeee6189fc45.gif)

# Installation

Expand All @@ -30,20 +30,20 @@ $ go install github.com/harakeishi/trv@latest

# Usage
## Setup
![setup](https://user-images.githubusercontent.com/44335168/198057520-99727df2-0e05-4a0b-b257-8b9fc305948c.gif)
![setup](https://user-images.githubusercontent.com/44335168/199011411-8b9f3da0-df23-45d2-b9ca-a507ae007866.gif)

The first time it is started, a configuration file is created.
Fill in the information for documents generated by `tbls`.

.| required |Description
--|--|--
Owner| * | Owner of the repository where the information is stored
Repo| * | Repository where information is stored
Path| * | Path of the document generated by `tbls`
Token| * | Github Token
IsEnterprise| | Is it GHES?
BaseURL| | Base URL for GHES
UploadURL| | Upload URL for GHES
| | Required |Example|Description|
|--|--|--|--|
|Owner| * |`harakeishi`|Owner of the repository where the information is stored|
|Repo| * |`trv`|Repository where information is stored|
|Path| * |`sampledb`|Path of the document generated by `tbls`|
|Token| * | |Github Token|
|IsEnterprise| || Is it GHES?|
|BaseURL|| `https://git.hoge.com/api/v3/` | Base URL for GHES|
|UploadURL|| `https://git.hoge.com/api/uploads/` | Upload URL for GHES|

Tokens for retrieving information in public repositories can be used without setting any specific permissions.

Expand Down

0 comments on commit 662a83b

Please sign in to comment.