Skip to content

Commit

Permalink
chore(repo): update README.md file
Browse files Browse the repository at this point in the history
  • Loading branch information
ekkolon committed Feb 6, 2024
1 parent a92aa80 commit 27c9044
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,20 @@
# Licensa

[![codecov](https://codecov.io/gh/ekkolon/licensa/graph/badge.svg?token=APBWVQY4HF)](https://codecov.io/gh/ekkolon/licensa)
![Crates.io Version](https://img.shields.io/crates/v/licensa)
![docs.rs](https://img.shields.io/docsrs/licensa)
![Crates.io License (version)](https://img.shields.io/crates/l/licensa/0.1.0)

Licensa is a powerful CLI tool designed for seamless source code license management. Developers can effortlessly **verify**, **apply**, **modify**, and **enforce** SPDX license headers across their source code.

As of today, Licensa boasts compatibility with over **65 file types**, making it a versatile and comprehensive solution for license management in diverse coding environments.

## Table of Contents

- [Installation](#installation)
- [License](#license)
- [Contribution](#contribution)

## Installation

### Linux
Expand Down Expand Up @@ -40,3 +51,18 @@ Executing the following script will walk you through the installation process (y
```powershell
Invoke-Expression -Command (Invoke-WebRequest -Uri "https://raw.githubusercontent.com/ekkolon/licensa/main/scripts/install.ps1" -UseBasicParsing).Content
```

## License

Licensed under either of

- [MIT license](https://spdx.org/licenses/MIT.html) (see [LICENSE-MIT](/LICENSE-MIT)) or
- [Apache License, Version 2.0](https://spdx.org/licenses/Apache-2.0.html) (see [LICENSE-APACHE](/LICENSE-APACHE))

at your option.

## Contribution

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

0 comments on commit 27c9044

Please sign in to comment.