update cargo-about details (#664)

parseablehq · Feb 19, 2024 · cffa2d2 · cffa2d2
1 parent 22c82c4
commit cffa2d2
Show file tree

Hide file tree

Showing 3 changed files with 153 additions and 37 deletions.
diff --git a/README.md b/README.md
@@ -89,6 +89,24 @@ But with log data growing exponentially, today's log data challenges involve who
 
 <a href="https://github.com/parseablehq/parseable/graphs/contributors"><img src="https://contrib.rocks/image?repo=parseablehq/parseable" /></a>
 
+### License report
+
+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.
+
+If not already installed, install `cargo-about` using the below command.
+
+```sh
+cargo install --locked cargo-about && cargo about init
+```
+
+To generate a license report, run the below command.
+
+```sh
+cargo about generate about.hbs > parseable-license.html
+```
+
+You can see the license report in the file parseable-license.html.
+
 ### Supported by
 
 <a href="https://fossunited.org/" target="_blank"><img src="http://fossunited.org/files/fossunited-badge.svg"></a>

diff --git a/about.hbs b/about.hbs
@@ -38,8 +38,8 @@
 <body>
     <main class="container">
         <div class="intro">
-            <h1>Third Party Licenses</h1>
-            <p>This page lists the licenses of the projects used in cargo-about.</p>
+            <h1>Third Party Licenses used in Parseable</h1>
+            <p>This page lists the licenses of the projects used in Parseable.</p>
         </div>
 
         <h2>Overview of licenses:</h2>