Skip to content

docs: Improve README.md#30

Draft
xeho91 wants to merge 5 commits intomainfrom
docs/#28_improve-readme
Draft

docs: Improve README.md#30
xeho91 wants to merge 5 commits intomainfrom
docs/#28_improve-readme

Conversation

@xeho91
Copy link
Copy Markdown
Contributor

@xeho91 xeho91 commented Oct 28, 2023

Resolves #28

Preview

@xeho91 xeho91 added the documentation Improvements or additions to documentation label Oct 28, 2023
@xeho91 xeho91 self-assigned this Oct 28, 2023
Comment thread README.md

## Security

TODO: Add link to security policy and badges SAST tools badges?
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@vpochapuis This depends on SAST tools choice, need further discussion

Comment thread README.md

![license badge](https://img.shields.io/github/license/rust-cleaners/polished-css?style=for-the-badge&link=https%3A%2F%2Fgithub.com%2Frust-cleaners%2Fpolished-css%2Fblob%2Fmain%2FLICENSE.md)

TODO: Add fossa.org badge
Copy link
Copy Markdown
Contributor Author

@xeho91 xeho91 Oct 28, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@vpochapuis https://fossa.com/, Github app need access granted to public/selected repos

Comment thread README.md
> **Note**
> 🔈 **Help wanted! We're calling for contributors to speed up stabilizing this [library project to version `1.0.0`](https://github.com/rust-cleaners/polished-css/milestone/1)**!

TODO: Add more, link to the `CONTRIBUTING.md`, credits to the contributors, list them, etc.
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs to be finished

Comment thread README.md
# polished-css

Build ✨polished🪽 Cascading Style Sheets (CSS) in Rust🦀. This crate strictly follows CSSWG standards/specifications and brings type-safety, modularity, and atomicity in the form of an ergonomic syntax to create custom styles for front-end applications.
TODO: Add project/crate logo
Copy link
Copy Markdown
Contributor Author

@xeho91 xeho91 Oct 28, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Insert project/crate logo there

@xeho91 xeho91 added this to the Version 1.0.0 milestone Oct 28, 2023
* add initial workflow file

* change format and improve comment output

* add schema comment

* update permissions
@xeho91 xeho91 marked this pull request as ready for review November 4, 2023 05:13
@xeho91 xeho91 marked this pull request as draft November 4, 2023 05:13
@xeho91 xeho91 changed the title Improve README.md docs: Improve README.md Nov 4, 2023
@xeho91 xeho91 changed the title docs: Improve README.md brokentitle docs: Improve README.md Nov 4, 2023
@xeho91 xeho91 changed the title brokentitle docs: Improve README.md brokentitleagain docs: Improve README.md Nov 4, 2023
@xeho91 xeho91 changed the title brokentitleagain docs: Improve README.md BROKEN! docs: Improve README.md Nov 4, 2023
@xeho91 xeho91 changed the title BROKEN! docs: Improve README.md docs: Improve README.md Nov 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add a Getting-Started or In Action section to the readme

1 participant