Merge pull request ossf#53 from joshbressers/20240521-readme

Update the readme with the proper link and running instructions
Mariuxdeangelo · May 22, 2024 · 53b2b5c · 53b2b5c
2 parents 6ecfd0c + f3753cb
commit 53b2b5c
Showing 1 changed file with 13 additions and 2 deletions.
diff --git a/SBOM-Catalog/contribute.md b/SBOM-Catalog/contribute.md
@@ -3,7 +3,18 @@
 This is a project to implement an SBOM Catalog inspired by the [Landscape of the Cloud Native Computing Foundation](https://landscape.cncf.io/).
 
 
-The page can be found [here](https://ossf.github.io/sbom-everywhere/)
+The page can be found [here](https://sbom-catalog.openssf.org/)
+
+## How to run the tool locally
+
+Run the comamnds
+```
+npm install
+npm run dev
+```
+
+Visiting the URL specificed by the tool should show you the current version
+of the site.
 
 ## How to add your tool
 If you know of a tool or project that should be listed here, please open an Issue or add a MergeRequest. There are three things to consider while adding a new tool:
@@ -72,4 +83,4 @@ ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
-</details>
+</details>