Skip to content

Commit ef23196

Browse files
committed
docs: Update README & docs/CONTRIBUTING
1 parent aa29f42 commit ef23196

File tree

2 files changed

+6
-21
lines changed

2 files changed

+6
-21
lines changed

README.md

Lines changed: 2 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ This requirement may be updated between minor versions of the library.
2020

2121
For more information, see the project's documentation site: [**eemeli.org/yaml**](https://eemeli.org/yaml/)
2222

23+
For build instructions and contribution guidelines, see [docs/CONTRIBUTING.md](docs/CONTRIBUTING.md).
24+
2325
To install:
2426

2527
```sh
@@ -30,26 +32,6 @@ deno add jsr:@eemeli/yaml
3032

3133
**Note:** These docs are for `yaml@2`. For v1, see the [v1.10.0 tag](https://github.com/eemeli/yaml/tree/v1.10.0) for the source and [eemeli.org/yaml/v1](https://eemeli.org/yaml/v1/) for the documentation.
3234

33-
The development and maintenance of this library is [sponsored](https://github.com/sponsors/eemeli) by:
34-
35-
<p align="center" width="100%">
36-
<a href="https://www.scipress.io/"
37-
><img
38-
width="150"
39-
align="top"
40-
src="https://eemeli.org/yaml/images/scipress.svg"
41-
alt="Scipress"
42-
/></a>
43-
&nbsp; &nbsp;
44-
<a href="https://manifest.build/"
45-
><img
46-
width="150"
47-
align="top"
48-
src="https://eemeli.org/yaml/images/manifest.svg"
49-
alt="Manifest"
50-
/></a>
51-
</p>
52-
5335
## API Overview
5436

5537
The API provided by `yaml` has three layers, depending on how deep you need to go: [Parse & Stringify](https://eemeli.org/yaml/#parse-amp-stringify), [Documents](https://eemeli.org/yaml/#documents), and the underlying [Lexer/Parser/Composer](https://eemeli.org/yaml/#parsing-yaml).

docs/CONTRIBUTING.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ To that end, the order of priorities is:
1919
This also means that we want to simultaneously maintain compatibility with multiple versions of the spec, in particular YAML 1.1 and YAML 1.2.
2020

2121
4. **Keep it simple**.
22-
Extending the library needs to be done carefully, and keep in all of its users.
22+
Extending the library needs to be done carefully, and keep in mind all of its users.
2323
Different applications have different needs and so are provided with different APIs.
2424
In particular, custom tags are supported, but aren't part of the built-in schemas.
2525

@@ -67,3 +67,6 @@ Note that the CI environment runs tests in both Node.js and browsers, so using n
6767

6868
If you're intending to contribute to the upstream repo, please make sure that your code style matches the Prettier and ESLint rules.
6969
The easiest way to do that is to configure your editor to do that for you, but `lint` and `prettier` npm scripts are also provided.
70+
71+
If you use an LLM when writing pull requests, this must be explicitly declared in the pull request.
72+
If there is indication of undeclared LLM assistance, the pull request will be declined.

0 commit comments

Comments
 (0)