Skip to content

Commit 59f3a34

Browse files
committed
Added Acknowledgements section
1 parent b319a30 commit 59f3a34

File tree

1 file changed

+14
-10
lines changed

1 file changed

+14
-10
lines changed

README.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Allows CSS/SVG named colors to be used directly in a Typst document.
55

66
## Template adaptation checklist
77

8-
- [ ] Fill out `README.md`
8+
- [x] Fill out `README.md`
99
- Change the `my-package` package name, including code snippets
1010
- Check section contents and/or delete sections that don't apply
1111
- [x] Check and/or replace `LICENSE` by something that suits your needs
@@ -44,16 +44,16 @@ Normal text may be #text(fill: css("crimson"))[colored so.]
4444

4545
Follow these steps to set up your development environment and prepare for contributing to the project:
4646

47-
1. **Typst**
47+
1. **Typst:**
4848
Install Typst (version 0.13.0 or higher) using the [official installation instructions](https://github.com/typst/typst?tab=readme-ov-file#installation). Typst is required to work with the core functionality of the project.
4949

50-
1. **Just**
50+
1. **Just:**
5151
Install [Just](https://just.systems/man/en/introduction.html), a handy command runner for executing predefined tasks. You can install it using a package manager or by downloading a pre-built binary. Refer to the [available packages](https://just.systems/man/en/packages.html) for installation instructions specific to your operating system.
5252

53-
1. **tytanic**
53+
1. **tytanic:**
5454
Install [tytanic](https://tingerrr.github.io/tytanic/index.html), a library essential for testing and working with Typst projects. Use the [quickstart installation guide](https://tingerrr.github.io/tytanic/quickstart/install.html) to get it up and running.
5555

56-
1. **Clone the Repository**
56+
1. **Clone the Repository:**
5757
Download the project's source code by cloning the repository to your local machine:
5858

5959
```bash
@@ -82,7 +82,7 @@ just test
8282
8383
Ensure that all tests pass before submitting any changes to maintain the project's integrity.
8484

85-
If you want to test the module with a typst file, you can install the css-colors package locally in the preview location by running:
85+
If you want to test the module with a typst file, you can install the `css-colors` package locally in the `preview` location by running:
8686

8787
```bash
8888
just install-preview
@@ -98,12 +98,14 @@ This setup allows you to experiment with the module in a typst file before final
9898

9999
## Usage
100100

101-
Here are some examples demonstrating how to use the css-colors module:
101+
Here are some examples demonstrating how to use the `css-colors` module:
102102

103103
```typ
104104
#import "@preview/css-colors:0.1.0": *
105105
106-
#rect(width: 100%, height: auto, fill: css("darkorchid"))
106+
(a) saddlebrown: #box(width: 30mm, height: 1em, fill: css("saddlebrown"))
107+
108+
(b) SaddleBrown: #box(width: 30mm, height: 1em, fill: css("SaddleBrown"))
107109
108110
#align(center)[
109111
#polygon.regular(
@@ -115,6 +117,8 @@ Here are some examples demonstrating how to use the css-colors module:
115117
]
116118
```
117119

118-
For additional examples and detailed explanations, refer to the project manual.
120+
For additional examples, detailed explanations and the actual PDF output refer to the project manual.
121+
122+
## Acknowledgments
119123

120-
## Additional Documentation and Acknowledgments
124+
We would like to thank the Typst community on Discord for giving invaluable support during the development of this package.

0 commit comments

Comments
 (0)