Skip to content

Commit

Permalink
Improve README
Browse files Browse the repository at this point in the history
  • Loading branch information
alexferrari88 committed Jan 19, 2024
1 parent 914257b commit 2e50d4d
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@ Simple CLI tool to download one or all the posts from a Substack blog.

## Installation

### Downloading the binary

Check in the [releases](https://github.com/alexferrari88/sbstck-dl/releases) page for the latest version of the binary for your platform.
We provide binaries for Linux, MacOS and Windows.

### Using Go

```bash
go install github.com/alexferrari88/sbstck-dl
```
Expand All @@ -15,7 +22,6 @@ Usage:
sbstck-dl [command]

Available Commands:
completion Generate the autocompletion script for the specified shell
download Download individual posts or the entire public archive
help Help about any command
list List the posts of a Substack
Expand Down Expand Up @@ -98,11 +104,12 @@ sbstck-dl download --url https://example.substack.com --cookie_name substack.sid
## TODO
- [x] Add support for private newsletters
- [ ] Implementing resuming downloads
- [ ] Improve retry logic
- [x] Implement filtering
- [ ] Implement loading from config file
- [ ] Add support for downloading media
- [ ] Add tests
- [ ] Add CI
- [x] Add documentation
- [x] Add support for private newsletters
- [x] Implement filtering by date

0 comments on commit 2e50d4d

Please sign in to comment.