Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
almonk committed Oct 7, 2023
1 parent 059ed17 commit 87224e3
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,17 @@
`ogpk` is a simple CLI tool written in Go that fetches OpenGraph data from a given URL. If the optional dependency `timg` is installed, `ogpk` can also display the `og:image` directly in the terminal.


### Installation

* Go to the [releases page](/releases) and download the latest release for your platform.
* Extract the archive and move the executable to a directory in your `PATH` (e.g. `/usr/local/bin`)
* Make the executable executable, e.g.:

```bash
chmod +x /usr/local/bin/ogpk
```


### Usage

To fetch OpenGraph data from a website:
Expand Down

0 comments on commit 87224e3

Please sign in to comment.