Skip to content

Commit

Permalink
Update readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
francois2metz committed Nov 2, 2023
1 parent 1768cba commit a595b02
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,11 @@ On GitHub, the [github action][action] is the easiest way to use dependency drif

Create an empty directory with a `data` directory.

mkdir -p repository-drift/data
cd repository-drift
touch repositories.txt
```shell
mkdir -p repository-drift/data
cd repository-drift
touch repositories.txt
```

And create a `repositories.txt` file with one git repository per line.

Expand All @@ -23,15 +25,19 @@ If your package.json is in a subdirectory, you can use the `#` to specify the pa

Then run:

npx --package=https://github.com/Dependency-Drift-Tracker/dependency-drift-tracker -- dependency-drift-tracker
```shell
npx --package=https://github.com/Dependency-Drift-Tracker/dependency-drift-tracker -- dependency-drift-tracker
```

It will create or update json files in the data directory.

## Development

Run tests

npm test
```shell
npm test
```

## License

Expand Down

0 comments on commit a595b02

Please sign in to comment.