Skip to content

Commit 5469429

Browse files
committed
update README.md
Signed-off-by: Joseph Demcher <git@joedem.ch>
1 parent cfc00f5 commit 5469429

File tree

2 files changed

+29
-26
lines changed

2 files changed

+29
-26
lines changed

README.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ SimpleLogin CLI provides a convenient way to manage your SimpleLogin email alias
2222
### Install via pip
2323

2424
```bash
25-
pip install simplelogin-cli
25+
pip install simplelogin
2626
```
2727

2828
### Manual Installation
@@ -73,78 +73,78 @@ simplelogin-cli config view
7373

7474
```bash
7575
# List all aliases
76-
simplelogin-cli aliases list
76+
simplelogin aliases list
7777

7878
# Paginate through aliases
79-
simplelogin-cli aliases list --page=1
79+
simplelogin aliases list --page=1
8080

8181
# Show only enabled aliases
82-
simplelogin-cli aliases list --enabled
82+
simplelogin aliases list --enabled
8383

8484
# Show only disabled aliases
85-
simplelogin-cli aliases list --disabled
85+
simplelogin aliases list --disabled
8686

8787
# Show only pinned aliases
88-
simplelogin-cli aliases list --pinned
88+
simplelogin aliases list --pinned
8989

9090
# Search aliases
91-
simplelogin-cli aliases list --query="github"
91+
simplelogin aliases list --query="github"
9292
```
9393

9494
#### Create aliases
9595

9696
```bash
9797
# Create a custom alias
98-
simplelogin-cli aliases create custom github
98+
simplelogin aliases create custom github
9999
# You'll be prompted to select a suffix and mailbox
100100

101101
# Create a custom alias with options
102-
simplelogin-cli aliases create custom github --note="For GitHub notifications" --name="GitHub"
102+
simplelogin aliases create custom github --note="For GitHub notifications" --name="GitHub"
103103

104104
# Create a random alias
105-
simplelogin-cli aliases create random
105+
simplelogin aliases create random
106106

107107
# Create a random alias with word mode
108-
simplelogin-cli aliases create random --mode=word
108+
simplelogin aliases create random --mode=word
109109

110110
# Create a random alias with a note
111-
simplelogin-cli aliases create random --note="For newsletter signups"
111+
simplelogin aliases create random --note="For newsletter signups"
112112
```
113113

114114
#### Manage existing aliases
115115

116116
```bash
117117
# Toggle an alias (enable/disable)
118-
simplelogin-cli aliases toggle 123
118+
simplelogin aliases toggle 123
119119

120120
# Delete an alias
121-
simplelogin-cli aliases delete 123
121+
simplelogin aliases delete 123
122122

123123
# View detailed information about an alias
124-
simplelogin-cli aliases info 123
124+
simplelogin aliases info 123
125125
```
126126

127127
### Managing Custom Domains
128128

129129
```bash
130130
# List all custom domains
131-
simplelogin-cli domains list
131+
simplelogin domains list
132132

133133
# View domain details
134-
simplelogin-cli domains info 42
134+
simplelogin domains info 42
135135

136136
# Update domain settings
137-
simplelogin-cli domains update 42 --catch-all=true --random-prefix=true
137+
simplelogin domains update 42 --catch-all=true --random-prefix=true
138138

139139
# View deleted aliases for a domain
140-
simplelogin-cli domains trash 42
140+
simplelogin domains trash 42
141141
```
142142

143143
### Managing Mailboxes
144144

145145
```bash
146146
# List all mailboxes
147-
simplelogin-cli mailboxes list
147+
simplelogin mailboxes list
148148
```
149149

150150
## Advanced Usage
@@ -154,7 +154,7 @@ simplelogin-cli mailboxes list
154154
When creating a custom alias, you can specify which mailboxes should receive emails:
155155

156156
```bash
157-
simplelogin-cli aliases create custom github --mailboxes=1,2,3
157+
simplelogin aliases create custom github --mailboxes=1,2,3
158158
```
159159

160160
If you don't specify mailboxes, you'll be prompted to select them interactively.

pyproject.toml

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
[project]
2-
name = "simplelogin-cli"
3-
version = "0.2.0"
4-
description = "A command-line interface for managing your [SimpleLogin](https://simplelogin.io/) email aliases and custom domains."
5-
authors = ["Joseph Demcher <git@joedem.ch>"]
2+
name = "simplelogin"
3+
version = "0.2.1"
4+
description = "A command-line interface for managing your SimpleLogin email aliases and custom domains."
5+
authors = [{ name="Joseph Demcher", email="git@joedem.ch"}]
66
readme = "README.md"
77
license = "MIT"
8-
license-files = ["LICEN[CS]E*"]
8+
license-files = ["LICENSE.md"]
99
dependencies = [
1010
"requests>=2.25.0",
1111
"docopt>=0.6.2",
@@ -23,3 +23,6 @@ Documentation = "https://github.com/joedemcher/simplelogin-cli/README.md"
2323
[build-system]
2424
requires = ["hatchling"]
2525
build-backend = "hatchling.build"
26+
27+
[tool.hatch.build.targets.wheel]
28+
packages = ["simplelogin"]

0 commit comments

Comments
 (0)