@kecan0406/ttheme 1.0.43 → 1.0.45

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -82,21 +82,59 @@ Both images are drawn from the live catalog, so they always match what
82
82
  adds or drops single palettes any time, and a merged palette reaches everyone
83
83
  through `ttheme update` without waiting for a release.
84
84
 
85
+ ### Markets
86
+
87
+ Anyone can publish palettes from a GitHub repository. A market is named
88
+ `<owner>@<name>` — its repository's owner and the name its index gives — and
89
+ sits below the series in `ttheme preview` and `ttheme browse`, past a line:
90
+
91
+ ```
92
+ ▾ Evangelion
93
+ rei
94
+ asuka
95
+ ── markets ──────────
96
+ ▾ alice@pastel
97
+ dusk
98
+ rei
99
+ ```
100
+
101
+ ```sh
102
+ ttheme market search # repositories with the ttheme-market topic
103
+ ttheme market add alice/ttheme-pastel # or a folder
104
+ ttheme add alice@pastel/dusk
105
+ ```
106
+
107
+ Nobody reviews a market. Its palettes are colors and post numbers, never code,
108
+ and the contrast gate's numbers are shown for them but never enforced — only
109
+ the official catalog is held to the gate. `ttheme update` refreshes every
110
+ market; `ttheme market remove alice@pastel` drops one, and the palettes you
111
+ installed from it keep working. The official catalog is a market too
112
+ (`official`). [The markets page](https://kecan0406.github.io/ttheme/markets)
113
+ lists the public ones.
114
+
85
115
  ### Your own palettes
86
116
 
87
- `ttheme new dusk --from madoka` copies a palette into
88
- `~/.config/ttheme/palettes/<you>/dusk.toml`, named after your GitHub handle
89
- (`<you>/dusk`), and installs it. `ttheme edit` opens it in `$EDITOR` and
90
- refuses a result that fails the contrast gate, offering colors that pass;
91
- `ttheme check --fix` does the same for any palette of yours.
117
+ `ttheme new rei --from rei` makes `<you>@<market>/rei`, named after your GitHub
118
+ handle and a market name the first `new` asks for, in
119
+ `~/.config/ttheme/market/<market>`, and installs it. `ttheme edit rei` opens it
120
+ in `$EDITOR`; `ttheme check --fix` suggests colors that pass the gate.
121
+
122
+ A local market is already a repository layout: `palettes/*.toml`, the
123
+ `ttheme-market.json` index and a workflow that rebuilds the index on every
124
+ push. `ttheme market init <name>` makes one and prints the commands that
125
+ publish it:
126
+
127
+ ```sh
128
+ cd ~/.config/ttheme/market/<name>
129
+ git init -b main && git add -A && git commit -m "<you>@<name>"
130
+ gh repo create <you>/ttheme-<name> --public --source . --push
131
+ gh repo edit <you>/ttheme-<name> --add-topic ttheme-market
132
+ ```
92
133
 
93
134
  `ttheme share <palette>` prints a code — `tt1:…`, about 200 characters — that
94
135
  carries the colors and the numbers of its background posts with their framing.
95
- `ttheme add tt1:…` installs it anywhere, fetching those posts from the booru the
96
- way `find` does. `ttheme submit <palette>` opens a filled-in GitHub issue; a bot
97
- checks it and turns it into a pull request for the catalog, where it appears
98
- as `<you>/<palette>` next to the palette it came from. A palette that leaves the
99
- catalog keeps working for whoever installed it.
136
+ `ttheme add tt1:…` installs it anywhere without a market, fetching those posts
137
+ from the booru the way `find` does.
100
138
 
101
139
  ## Usage
102
140
 
@@ -108,11 +146,13 @@ catalog keeps working for whoever installed it.
108
146
  | `ttheme default <palette>` | the palette new tabs open with |
109
147
  | `ttheme pin` / `unpin` | a palette for this directory — `cd` in repaints, `cd` out restores |
110
148
  | `ttheme browse` | pick palettes from the catalog |
111
- | `ttheme new <name> --from <palette>` | make a palette of your own; `edit`, `check`, `share`, `submit` follow |
149
+ | `ttheme market add <owner/repo>` | add someone's market — `ttheme market` lists yours; `search`, `remove` too |
150
+ | `ttheme new <name> --from <palette>` | make a palette of your own; `edit`, `check`, `share` follow |
112
151
  | `ttheme on` / `off` | wear the default again / give the terminal its own colors back |
113
152
  | `ttheme config` | settings in `$EDITOR` |
114
153
 
115
- `ttheme help` lists everything. Preview's keys, directory pins, rotating new
154
+ `ttheme help` shows the three to start with and the rest by task; `ttheme help
155
+ all` lists every command. Preview's keys, directory pins, rotating new
116
156
  tabs and every setting are in [docs/usage.md](docs/usage.md).
117
157
 
118
158
  ## Terminal support
@@ -139,9 +179,9 @@ window. See [docs/backgrounds.md](docs/backgrounds.md).
139
179
  ## Contributing
140
180
 
141
181
  A palette is one TOML file of color values and post numbers — never images.
142
- `ttheme submit` sends one of yours without a checkout;
143
- [CONTRIBUTING.md](CONTRIBUTING.md) has the rules, the file format and the
144
- checks it must pass.
182
+ Your own go in your own market, with no review; the official catalog takes pull
183
+ requests, and [CONTRIBUTING.md](CONTRIBUTING.md) has its rules, the file format
184
+ and the checks a palette must pass.
145
185
 
146
186
  ## Credits
147
187