Skip to content

Commit

Permalink
Update README.md to be more like the Linebender style (#26)
Browse files Browse the repository at this point in the history
  • Loading branch information
waywardmonkeys authored Jan 3, 2025
1 parent f497426 commit e399213
Showing 1 changed file with 51 additions and 12 deletions.
63 changes: 51 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,26 @@
## simplecss
![Build Status](https://github.com/RazrFalcon/simplecss/workflows/simplecss/badge.svg)
<div align="center">

# SimpleCSS

**A simple [CSS 2.1](https://www.w3.org/TR/CSS21/) parser and selector.**

[![Linebender Zulip, #resvg channel](https://img.shields.io/badge/Linebender-%23resvg-blue?logo=Zulip)](https://xi.zulipchat.com/#narrow/channel/465085-resvg)
[![dependency status](https://deps.rs/repo/github/linebender/simplecss/status.svg)](https://deps.rs/repo/github/linebender/simplecss)
[![Apache 2.0 or MIT license.](https://img.shields.io/badge/license-Apache--2.0_OR_MIT-blue.svg)](#license)
[![Build status](https://github.com/linebender/simplecss/workflows/CI/badge.svg)](https://github.com/linebender/simplecss/actions)
[![Crates.io](https://img.shields.io/crates/v/simplecss.svg)](https://crates.io/crates/simplecss)
[![Documentation](https://docs.rs/simplecss/badge.svg)](https://docs.rs/simplecss)
[![Rust 1.37+](https://img.shields.io/badge/rust-1.37+-orange.svg)](https://www.rust-lang.org)
[![Docs](https://docs.rs/simplecss/badge.svg)](https://docs.rs/simplecss)
![](https://img.shields.io/badge/unsafe-forbidden-brightgreen.svg)

A simple [CSS 2.1](https://www.w3.org/TR/CSS21/) parser and selector.
</div>

This is not a browser-grade CSS parser. If you need one,
use [cssparser](https://crates.io/crates/cssparser) +
[selectors](https://crates.io/crates/selectors).

Since it's very simple we will start with limitations:

### Limitations
## Limitations

- [At-rules](https://www.w3.org/TR/CSS21/syndata.html#at-rules) are not supported.
They will be skipped during parsing.
Expand All @@ -23,27 +30,59 @@ Since it's very simple we will start with limitations:
- Parser is case sensitive. All keywords must be lowercase.
- Unicode escape, like `\26`, is not supported.

### Features
## Features

- Selector matching support.
- The rules are sorted by specificity.
- `!important` parsing support.
- Has a high-level parsers and low-level, zero-allocation tokenizers.
- No unsafe.

### License
## Minimum supported Rust Version (MSRV)

This version of SimpleCSS has been verified to compile with **Rust 1.65** and later.

Future versions of SimpleCSS might increase the Rust version requirement.
It will not be treated as a breaking change and as such can even happen with small patch releases.

<details>
<summary>Click here if compiling fails.</summary>

As time has passed, some of SimpleCSS's dependencies could have released versions with a higher Rust requirement.
If you encounter a compilation issue due to a dependency and don't want to upgrade your Rust toolchain, then you could downgrade the dependency.

```sh
# Use the problematic dependency's name and version
cargo update -p package_name --precise 0.1.1
```
</details>

## Community

[![Linebender Zulip, #resvg channel](https://img.shields.io/badge/Linebender-%23resvg-blue?logo=Zulip)](https://xi.zulipchat.com/#narrow/channel/465085-resvg)

Discussion of SimpleCSS development happens in the Linebender Zulip at <https://xi.zulipchat.com/>, specifically the [#resvg channel](https://xi.zulipchat.com/#narrow/channel/465085-resvg).
All public content can be read without logging in.

## License

Licensed under either of

- Apache License, Version 2.0
([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
([LICENSE-APACHE](LICENSE-APACHE) or <http://www.apache.org/licenses/LICENSE-2.0>)
- MIT license
([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
([LICENSE-MIT](LICENSE-MIT) or <http://opensource.org/licenses/MIT>)

at your option.

### Contribution
## Contribution

Contributions are welcome by pull request. The [Rust code of conduct] applies.
Please feel free to add your name to the [AUTHORS] file in any substantive pull request.

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.
licensed as above, without any additional terms or conditions.

[Rust Code of Conduct]: https://www.rust-lang.org/policies/code-of-conduct
[AUTHORS]: ./AUTHORS

0 comments on commit e399213

Please sign in to comment.