Skip to content

Commit cffa2d2

Browse files
authored
update cargo-about details (#664)
1 parent 22c82c4 commit cffa2d2

File tree

3 files changed

+153
-37
lines changed

3 files changed

+153
-37
lines changed

README.md

+18
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,24 @@ But with log data growing exponentially, today's log data challenges involve who
8989

9090
<a href="https://github.com/parseablehq/parseable/graphs/contributors"><img src="https://contrib.rocks/image?repo=parseablehq/parseable" /></a>
9191

92+
### License report
93+
94+
A license report lists all the licenses of all dependencies in a project. You can use [cargo-about ↗︎](https://embarkstudios.github.io/cargo-about/) to generate a license report for the Parseable.
95+
96+
If not already installed, install `cargo-about` using the below command.
97+
98+
```sh
99+
cargo install --locked cargo-about && cargo about init
100+
```
101+
102+
To generate a license report, run the below command.
103+
104+
```sh
105+
cargo about generate about.hbs > parseable-license.html
106+
```
107+
108+
You can see the license report in the file parseable-license.html.
109+
92110
### Supported by
93111

94112
<a href="https://fossunited.org/" target="_blank"><img src="http://fossunited.org/files/fossunited-badge.svg"></a>

about.hbs

+2-2
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@
3838
<body>
3939
<main class="container">
4040
<div class="intro">
41-
<h1>Third Party Licenses</h1>
42-
<p>This page lists the licenses of the projects used in cargo-about.</p>
41+
<h1>Third Party Licenses used in Parseable</h1>
42+
<p>This page lists the licenses of the projects used in Parseable.</p>
4343
</div>
4444

4545
<h2>Overview of licenses:</h2>

0 commit comments

Comments
 (0)