Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
gabotechs committed Jan 31, 2024
1 parent 610df5e commit 7505414
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,8 @@ rules for ensuring its loosely coupling.

It works with files, meaning that each file is a node in the dependency tree:

- It starts from an entrypoint, which is usually the main executable file in a
program or the file that exposes the contents of a library (like `package/main.py`, `src/index.ts`, `src/lib.rs`...).
- It starts from one or more entrypoints, which are usually the main executable files in a
program or the files that expose the contents of a library (like `package/main.py`, `src/index.ts`, `src/lib.rs`...).
- It makes a parent node out of the root file, and one child node for each imported file.

> [!NOTE]
Expand All @@ -105,6 +105,12 @@ Choose the file that will act as the root of the dependency graph (for example `
dep-tree entropy src/index.ts
```

You can also pass multiple files if you don't have a single entrypoint:

```shell
dep-tree entropy src/*
```

It will open a browser window and will render your file dependency graph using a 3d force-directed graph.

The spheres (files) will be placed mimicking some attraction/repulsion forces. Some parts of your code
Expand Down

0 comments on commit 7505414

Please sign in to comment.