Skip to content

Commit 2e50d4d

Browse files
committed
Improve README
1 parent 914257b commit 2e50d4d

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@ Simple CLI tool to download one or all the posts from a Substack blog.
44

55
## Installation
66

7+
### Downloading the binary
8+
9+
Check in the [releases](https://github.com/alexferrari88/sbstck-dl/releases) page for the latest version of the binary for your platform.
10+
We provide binaries for Linux, MacOS and Windows.
11+
12+
### Using Go
13+
714
```bash
815
go install github.com/alexferrari88/sbstck-dl
916
```
@@ -15,7 +22,6 @@ Usage:
1522
sbstck-dl [command]
1623

1724
Available Commands:
18-
completion Generate the autocompletion script for the specified shell
1925
download Download individual posts or the entire public archive
2026
help Help about any command
2127
list List the posts of a Substack
@@ -98,11 +104,12 @@ sbstck-dl download --url https://example.substack.com --cookie_name substack.sid
98104
99105
## TODO
100106
101-
- [x] Add support for private newsletters
107+
- [ ] Implementing resuming downloads
102108
- [ ] Improve retry logic
103-
- [x] Implement filtering
104109
- [ ] Implement loading from config file
105110
- [ ] Add support for downloading media
106111
- [ ] Add tests
107112
- [ ] Add CI
108113
- [x] Add documentation
114+
- [x] Add support for private newsletters
115+
- [x] Implement filtering by date

0 commit comments

Comments
 (0)