Skip to content

Commit 1a0f281

Browse files
committed
Completed all changes to README.md
1 parent 3b4a0e6 commit 1a0f281

File tree

2 files changed

+2
-24
lines changed

2 files changed

+2
-24
lines changed

README.md

Lines changed: 2 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,6 @@
44

55
Allows CSS/SVG named colors to be used directly in a Typst document.
66

7-
## Template adaptation checklist
8-
9-
- [x] Fill out `README.md`
10-
- Change the `my-package` package name, including code snippets
11-
- Check section contents and/or delete sections that don't apply
12-
- [x] Check and/or replace `LICENSE` by something that suits your needs
13-
- [x] Fill out `typst.toml`
14-
- See also the [typst/packages README](https://github.com/typst/packages/?tab=readme-ov-file#package-format)
15-
- [x] Adapt Repository URLs in `CHANGELOG.md`
16-
- Consider only committing that file with your first release, or removing the "Initial Release" part in the beginning
17-
- [ ] Adapt or deactivate the release workflow in `.github/workflows/release.yml`
18-
- to deactivate it, delete that file or remove/comment out lines 2-4 (`on:` and following)
19-
- to use the workflow
20-
- [ ] check the values under `env:`, particularly `REGISTRY_REPO`
21-
- [ ] if you don't have one, [create a fine-grained personal access token](https://github.com/settings/tokens?type=beta) with [only Contents permission](https://stackoverflow.com/a/75116350/371191) for the `REGISTRY_REPO`
22-
- [ ] on this repo, create a secret `REGISTRY_TOKEN` (at `https://github.com/[user]/[repo]/settings/secrets/actions`) that contains the so created token
23-
24-
if configured correctly, whenever you create a tag `v...`, your package will be pushed onto a branch on the `REGISTRY_REPO`, from which you can then create a pull request against [typst/packages](https://github.com/typst/packages/)
25-
- [x] remove/replace the example test case
26-
- [x] (add your actual code, docs and tests)
27-
- [ ] remove this section from the README
28-
297
## Getting Started
308

319
These instructions will get you a copy of the project up and running on the Typst web app.
@@ -119,8 +97,8 @@ The following examples demonstrate the usage of the `css-colors` package in vari
11997
<img src="./thumbnail-2-light.svg" alt="">
12098
</picture>
12199

122-
For additional examples, detailed explanations and the actual PDF output refer to the project manual.
100+
For more examples, in-depth explanations, and the PDF output, please refer to the project manual.
123101

124102
## Acknowledgments
125103

126-
I would like to thank the Typst community on [Discord](https://discord.com/channels/1054443721975922748/1069937650125000807) for giving invaluable support during the development of this package.
104+
Special thanks to the Typst community on [Discord](https://discord.com/channels/1054443721975922748/1069937650125000807) for their invaluable assistance and support during the development of this package.

docs/manual.pdf

0 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)