Skip to content

Commit

Permalink
Bump to 1.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
ericyd committed Dec 3, 2021
1 parent 579f1b6 commit d86d885
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 32 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ cargo-features = ["strip"]

[package]
name = "twitter"
version = "0.1.0"
version = "1.0.0"
edition = "2018"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
Expand Down
71 changes: 40 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
- [`help`](#help)
- [Global arguments](#global-arguments)
- [Building from source](#building-from-source)
- [Releasing](#releasing)
- [Troubleshooting](#troubleshooting)
- [I am getting authentication errors](#i-am-getting-authentication-errors)
- [Acknowledgements](#acknowledgements)
Expand Down Expand Up @@ -61,6 +62,18 @@
5. See what's new: `tw feed`
6. Add to the conversation `tw post "new phone who dis"`

Or as shell commands:

```bash
curl -L https://github.com/ericyd/twittier/releases/download/1.0.0/twittier-1.0.0-linux.zip > twittier-1.0.0-linux.zip
unzip twittier-1.0.0-linux.zip
ln -s "$(pwd)/twittier-1.0.0-linux/tw" /usr/local/bin/tw2
tw init
vi ~/.twitter_credentials.toml
# insert credentials ^
tw feed
```

## API

### `init`
Expand Down Expand Up @@ -200,20 +213,44 @@ tw init -c /path/to/custom/file.toml

## Building from source

Install [Rust and Cargo](https://www.rust-lang.org/learn/get-started)
1. Install [Rust and Cargo](https://www.rust-lang.org/learn/get-started)
2. Set nightly toolchain (required for the `strip` feature)

```bash
rustup default +nightly
```

3. Clone and build

```bash
# Clone repo as needed
git clone https://github.com/ericyd/twittier && cd twittier

# Build and create link
# Build
cargo build --release
# or, if you don't use nightly as your default toolchain
cargo +nightly build --release
# Or, if cargo wasn't installed with Rustup, invoke directly
rustup run nightly cargo build --release

# create link
ln -s "$(pwd)/target/release/tw" /usr/local/bin/tw

# Use
# Use it
tw -h
```

## Releasing

Turns out cross-compiling is quite hard locally so just use GitHub Actions - its free!

```bash
# cut tag
git tag 1.0.0 -s
# you're done, GH Actions does the rest 🙌
git push --tags
```

## Troubleshooting

### I am getting authentication errors
Expand All @@ -229,34 +266,6 @@ Be sure to generate an access token and secret after you update your app to have
- <sup>1</sup>This has never been, and will never be, measured
- <sup>2</sup>Non-functional Tweets

## Building

Building requires the nightly toolchain for the `strip` feature

```bash
# Build
cargo +nightly build --release

# Or, if cargo wasn't installed with Rustup, invoke directly with
rustup run nightly cargo build --release

# Or, set as default
rustup default +nightly

ls -l ./target/release/tw
```

## Releasing

Turns out cross-compiling is quite hard locally so just use GitHub Actions - its free!

```bash
# cut tag
git tag 1.0.0 -s
# you're done, GH Actions does the rest 🙌
git push --tags
```

---

Follow me [@ericydauenhauer](https://twitter.com/ericydauenhauer) for good times

0 comments on commit d86d885

Please sign in to comment.