Skip to content

Commit

Permalink
Updating README and repo name
Browse files Browse the repository at this point in the history
  • Loading branch information
eoftedal committed Feb 16, 2024
1 parent 81fd239 commit d4ea6ac
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 10 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Changelog

## 1.0.4

Renaming repository from retire-scanner to retire-site-scanner as name was taken


## 1.0.3

Renaming from retire-scanner to retire-site-scanner as name was taken
Expand Down
31 changes: 24 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,25 +3,42 @@
Scans a URL and looks for JavaScript libraries with known vulnerabilities using retire.js. Can also produce a partial SBOM for the site.


### Install
## Install with npm

```
git clone [email protected]:RetireJS/retire-scanner.git
cd retire-scanner
npm install -g retire-site-scanner
```
Run:
```
retire-site-scanner [-v] [--sbom] <url>
```

## Run using docker

```
docker run --rm ghcr.io/retirejs/retire-site-scanner:latest [-v] [--sbom] <url>
```


## Install from source

```
git clone [email protected]:RetireJS/retire-site-scanner.git
cd retire-site-scanner
npm install
```

### Direct
### Run directly from source
```
npm run start -- <url> [-v] [--sbom]
```
### Docker
### Run using Docker

**Build container**

```
git clone [email protected]:RetireJS/retire-scanner.git
cd retire-scanner
git clone [email protected]:RetireJS/retire-site-scanner.git
cd retire-site-scanner
docker build -t retire-site-scanner .
```
**Scanning**
Expand Down
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@
"main": "dist/index.js",
"repository": {
"type": "git",
"url": "https://github.com/RetireJS/retire-scanner.git"
"url": "https://github.com/RetireJS/retire-site-scanner.git"
},
"bin": {
"retire-scanner": "dist/index.js"
"retire-site-scanner": "dist/index.js"
},
"scripts": {
"start": "ts-node src/index",
Expand Down

0 comments on commit d4ea6ac

Please sign in to comment.