Skip to content

Commit

Permalink
chore: add LICENSE
Browse files Browse the repository at this point in the history
  • Loading branch information
dhth committed Sep 23, 2024
1 parent 2bce519 commit 809d028
Show file tree
Hide file tree
Showing 5 changed files with 67 additions and 30 deletions.
7 changes: 6 additions & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ jobs:
# we specify bash to get pipefail; it guards against the `curl` command
# failing. otherwise `sh` won't catch that `curl` returned non-0
shell: bash
run: "curl --proto '=https' --tlsv1.2 -LsSf https://github.com/axodotdev/cargo-dist/releases/download/v0.21.1/cargo-dist-installer.sh | sh"
run: "curl --proto '=https' --tlsv1.2 -LsSf https://github.com/axodotdev/cargo-dist/releases/download/v0.22.1/cargo-dist-installer.sh | sh"
- name: Cache cargo-dist
uses: actions/upload-artifact@v4
with:
Expand Down Expand Up @@ -307,6 +307,11 @@ jobs:
name=$(echo "$filename" | sed "s/\.rb$//")
version=$(echo "$release" | jq .app_version --raw-output)
export PATH="/home/linuxbrew/.linuxbrew/bin:$PATH"
brew update
# We avoid reformatting user-provided data such as the app description and homepage.
brew style --except-cops FormulaAudit/Homepage,FormulaAudit/Desc,FormulaAuditStrict --fix "Formula/${filename}" || true
git add "Formula/${filename}"
git commit -m "${name} ${version}"
done
Expand Down
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 11 additions & 2 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,10 +1,19 @@
[package]
name = "tbll"
version = "0.2.0"
version = "0.2.1"
edition = "2021"
repository = "https://github.com/dhth/tbll"
description = "tbll outputs data in tabular format"
homepage = "https://github.com/dhth/tbll"
license-file = "LICENSE"
keywords = [
"cli",
"table",
]
categories = [
"command-line-utilities",
"text-processing"
]

[dependencies]
clap = { version = "4.5.18", features = ["derive"] }
Expand All @@ -18,7 +27,7 @@ lto = "thin"
# Config for 'cargo dist'
[workspace.metadata.dist]
# The preferred cargo-dist version to use in CI (Cargo.toml SemVer syntax)
cargo-dist-version = "0.21.1"
cargo-dist-version = "0.22.1"
# CI backends to support
ci = "github"
# The installers to generate for each app
Expand Down
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 Dhruv Thakur

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
54 changes: 28 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,30 @@

`tbll` outputs data in tabular format.

```bash
cat << EOF | tbll -s --headers 'Movie,Year,Director,Genre'
The Matrix,1999,Lana & Lilly Wachowski,Science Fiction
Fight Club,1999,David Fincher,Drama
Pulp Fiction,1994,Quentin Tarantino,Crime
The Shawshank Redemption,1994,Frank Darabont,Drama
Jurassic Park,1993,Steven Spielberg,Adventure
Forrest Gump,1994,Robert Zemeckis,Drama
EOF
```

```text
┌──────────────────────────┬──────┬────────────────────────┬─────────────────┐
│ Movie │ Year │ Director │ Genre │
├──────────────────────────┼──────┼────────────────────────┼─────────────────┤
│ The Matrix │ 1999 │ Lana & Lilly Wachowski │ Science Fiction │
│ Fight Club │ 1999 │ David Fincher │ Drama │
│ Pulp Fiction │ 1994 │ Quentin Tarantino │ Crime │
│ The Shawshank Redemption │ 1994 │ Frank Darabont │ Drama │
│ Jurassic Park │ 1993 │ Steven Spielberg │ Adventure │
│ Forrest Gump │ 1994 │ Robert Zemeckis │ Drama │
└──────────────────────────┴──────┴────────────────────────┴─────────────────┘
```

💾 Installation
---

Expand All @@ -17,11 +41,13 @@ brew install dhth/tap/tbll
**cargo**:

```sh
cargo install tbll
cargo install --git https://github.com/dhth/tbll.git
```

Or get the binaries directly from a [release][1]. Read more about verifying the
authenticity of released artifacts [here](#-verifying-release-artifacts).
Or get the binaries directly from a Github [release][1]. Read more about
verifying the authenticity of released artifacts
[here](#-verifying-release-artifacts).

⚡️ Usage
---
Expand All @@ -47,30 +73,6 @@ Options:

### Basic Usage

```bash
cat << EOF | tbll -s --headers 'Movie,Year,Director,Genre'
The Matrix,1999,Lana & Lilly Wachowski,Science Fiction
Fight Club,1999,David Fincher,Drama
Pulp Fiction,1994,Quentin Tarantino,Crime
The Shawshank Redemption,1994,Frank Darabont,Drama
Jurassic Park,1993,Steven Spielberg,Adventure
Forrest Gump,1994,Robert Zemeckis,Drama
EOF
```

```text
┌──────────────────────────┬──────┬────────────────────────┬─────────────────┐
│ Movie │ Year │ Director │ Genre │
├──────────────────────────┼──────┼────────────────────────┼─────────────────┤
│ The Matrix │ 1999 │ Lana & Lilly Wachowski │ Science Fiction │
│ Fight Club │ 1999 │ David Fincher │ Drama │
│ Pulp Fiction │ 1994 │ Quentin Tarantino │ Crime │
│ The Shawshank Redemption │ 1994 │ Frank Darabont │ Drama │
│ Jurassic Park │ 1993 │ Steven Spielberg │ Adventure │
│ Forrest Gump │ 1994 │ Robert Zemeckis │ Drama │
└──────────────────────────┴──────┴────────────────────────┴─────────────────┘
```

```bash
cat <<EOF | tbll -s -d ':::' \
--headers 'col1,col2,col3' \
Expand Down

0 comments on commit 809d028

Please sign in to comment.