Skip to content

Commit e1a45ba

Browse files
vikingairvikingair
authored
Cleanup README and remove Travis config (#422)
1 parent af88f3a commit e1a45ba

File tree

2 files changed

+74
-87
lines changed

2 files changed

+74
-87
lines changed

‎.travis.yml

-13
This file was deleted.

‎README.md

+74-74
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,19 @@
11
<p align="center">
2-
<img alt="madge" src="http://pahen.github.io/madge/logo.svg" width="320">
2+
<img alt="madge" src="http://pahen.github.io/madge/logo.svg" width="320">
33
</p>
44

55
<p align="center">
6-
<img alt="Last version" src="https://img.shields.io/github/tag/pahen/madge.svg?style=flat-square" />
7-
<a href="https://app.travis-ci.com/github/pahen/madge">
8-
<img alt="Build Status" src="http://img.shields.io/travis/pahen/madge/master.svg?style=flat-square" />
9-
</a>
10-
<a href="https://www.npmjs.org/package/madge">
11-
<img alg="NPM Status" src="http://img.shields.io/npm/dm/madge.svg?style=flat-square" />
12-
</a>
13-
<a href="https://paypal.me/pahen" target="_blank">
14-
<img alt="Donate" src="https://img.shields.io/badge/donate-paypal-blue.svg?style=flat-square" />
15-
</a>
6+
<img alt="Last version" src="https://img.shields.io/github/tag/pahen/madge.svg?style=flat-square" />
7+
<a href="https://www.npmjs.org/package/madge">
8+
<img alg="NPM Status" src="http://img.shields.io/npm/dm/madge.svg?style=flat-square" />
9+
</a>
10+
<a href="https://paypal.me/pahen" target="_blank">
11+
<img alt="Donate" src="https://img.shields.io/badge/donate-paypal-blue.svg?style=flat-square" />
12+
</a>
1613
</p>
1714

18-
1915
**Madge** is a developer tool for generating a visual graph of your module dependencies, finding circular dependencies, and giving you other useful info. Joel Kemp's awesome [dependency-tree](https://github.com/mrjoelkemp/node-dependency-tree) is used for extracting the dependency tree.
2016

21-
2217
* Works for JavaScript (AMD, CommonJS, and ES6 modules)
2318
* Also works for CSS preprocessors (Sass, Stylus, and Less)
2419
* NPM installed dependencies are excluded by default (can be enabled)
@@ -36,19 +31,19 @@ Read the [changelog](CHANGELOG.md) for latest changes.
3631
> Graph generated from madge's own code and dependencies.
3732
3833
<a href="http://pahen.github.io/madge/madge.svg">
39-
<img src="http://pahen.github.io/madge/madge.svg" width="888"/>
34+
<img alt="graph" src="http://pahen.github.io/madge/madge.svg" width="888"/>
4035
</a>
4136

4237
> A graph with circular dependencies. Blue has dependencies, green has no dependencies, and red has circular dependencies.
4338
4439
<a href="http://pahen.github.io/madge/simple.svg">
45-
<img src="http://pahen.github.io/madge/simple.svg" width="300"/>
40+
<img alt="graph-circular" src="http://pahen.github.io/madge/simple.svg" width="300"/>
4641
</a>
4742

4843
## See it in action
4944

5045
<a href="https://asciinema.org/a/l9tM7lIraCpmzH0rdWw2KLrMc?autoplay=1">
51-
<img src="https://asciinema.org/a/l9tM7lIraCpmzH0rdWw2KLrMc.png" width="590"/>
46+
<img alt="in-action" src="https://asciinema.org/a/l9tM7lIraCpmzH0rdWw2KLrMc.png" width="590"/>
5247
</a>
5348

5449
# Installation
@@ -244,29 +239,30 @@ You can use configuration file either in `.madgerc` in your project or home fold
244239
245240
```json
246241
{
247-
"fontSize": "10px",
248-
"graphVizOptions": {
249-
"G": {
250-
"rankdir": "LR"
251-
}
252-
}
242+
"fontSize": "10px",
243+
"graphVizOptions": {
244+
"G": {
245+
"rankdir": "LR"
246+
}
247+
}
253248
}
254249
```
255250

256251
> package.json
252+
257253
```json
258254
{
259-
"name": "foo",
260-
"version": "0.0.1",
261-
...
262-
"madge": {
263-
"fontSize": "10px",
264-
"graphVizOptions": {
265-
"G": {
266-
"rankdir": "LR"
267-
}
268-
}
269-
}
255+
"name": "foo",
256+
"version": "0.0.1",
257+
...
258+
"madge": {
259+
"fontSize": "10px",
260+
"graphVizOptions": {
261+
"G": {
262+
"rankdir": "LR"
263+
}
264+
}
265+
}
270266
}
271267
```
272268

@@ -298,7 +294,7 @@ madge path/src
298294
madge path/src/foo path/src/bar
299295
```
300296

301-
> List dependencies from all *.js and *.jsx files found in a directory
297+
> List dependencies from all \*.js and \*.jsx files found in a directory
302298
303299
```sh
304300
madge --extensions js,jsx path/src
@@ -394,24 +390,26 @@ Madge uses [dependency-tree](https://www.npmjs.com/package/dependency-tree) whic
394390
Only one syntax is used by default. You can use both though if you're willing to take the degraded performance. Put this in your madge config to enable mixed imports.
395391

396392
For ES6 + CommonJS:
393+
397394
```json
398395
{
399-
"detectiveOptions": {
400-
"es6": {
401-
"mixedImports": true
402-
}
403-
}
396+
"detectiveOptions": {
397+
"es6": {
398+
"mixedImports": true
399+
}
400+
}
404401
}
405402
```
406403

407404
For TypeScript + CommonJS:
405+
408406
```json
409407
{
410-
"detectiveOptions": {
411-
"ts": {
412-
"mixedImports": true
413-
}
414-
}
408+
"detectiveOptions": {
409+
"ts": {
410+
"mixedImports": true
411+
}
412+
}
415413
}
416414
```
417415

@@ -421,11 +419,11 @@ Put this in your madge config.
421419

422420
```json
423421
{
424-
"detectiveOptions": {
425-
"es6": {
426-
"skipTypeImports": true
427-
}
428-
}
422+
"detectiveOptions": {
423+
"es6": {
424+
"skipTypeImports": true
425+
}
426+
}
429427
}
430428
```
431429

@@ -435,11 +433,11 @@ Put this in your madge config.
435433

436434
```json
437435
{
438-
"detectiveOptions": {
439-
"ts": {
440-
"skipTypeImports": true
441-
}
442-
}
436+
"detectiveOptions": {
437+
"ts": {
438+
"skipTypeImports": true
439+
}
440+
}
443441
}
444442
```
445443

@@ -449,14 +447,14 @@ Put this in your madge config.
449447

450448
```json
451449
{
452-
"detectiveOptions": {
453-
"ts": {
454-
"skipAsyncImports": true
455-
},
456-
"tsx": {
457-
"skipAsyncImports": true
458-
}
459-
}
450+
"detectiveOptions": {
451+
"ts": {
452+
"skipAsyncImports": true
453+
},
454+
"tsx": {
455+
"skipAsyncImports": true
456+
}
457+
}
460458
}
461459
```
462460

@@ -468,10 +466,10 @@ Ensure you have this in your `.tsconfig` file.
468466

469467
```json
470468
{
471-
"compilerOptions": {
472-
"module": "commonjs",
473-
"allowJs": true
474-
}
469+
"compilerOptions": {
470+
"module": "commonjs",
471+
"allowJs": true
472+
}
475473
}
476474
```
477475

@@ -493,12 +491,12 @@ brew install graphviz
493491

494492
Try running madge with a different layout, here's a list of the ones you can try:
495493

496-
* **dot** "hierarchical" or layered drawings of directed graphs. This is the default tool to use if edges have directionality.
494+
* **dot** "hierarchical" or layered drawings of directed graphs. This is the default tool to use if edges have directionality.
497495

498496
* **neato** "spring model'' layouts. This is the default tool to use if the graph is not too large (about 100 nodes) and you don't know anything else about it. Neato attempts to
499497
minimize a global energy function, which is equivalent to statistical multi-dimensional scaling.
500498

501-
* **fdp** "spring model'' layouts similar to those of neato, but does this by reducing forces rather than working with energy.
499+
* **fdp** "spring model'' layouts similar to those of neato, but does this by reducing forces rather than working with energy.
502500

503501
* **sfdp** multiscale version of fdp for the layout of large graphs.
504502

@@ -511,7 +509,9 @@ minimize a global energy function, which is equivalent to statistical multi-dime
511509
## Contributors
512510

513511
This project exists thanks to all the people who contribute.
514-
<a href="https://github.com/pahen/madge/graphs/contributors"><img src="https://opencollective.com/madge/contributors.svg?width=890&button=false" alt="Contributors"/></a>
512+
<a href="https://github.com/pahen/madge/graphs/contributors">
513+
<img src="https://opencollective.com/madge/contributors.svg?width=890&button=false" alt="Contributors"/>
514+
</a>
515515

516516
## Donations ❤️
517517

@@ -520,35 +520,35 @@ Thanks to the awesome people below for making donations! 🙏[Donate](https://pa
520520
<p>
521521
<a href="https://github.com/BeroBurny" target="_blank">
522522
<div><b>Bernard Stojanović</b> (24 Mars, 2021)</div>
523-
<img src="https://github.com/BeroBurny.png" width="64"/>
523+
<img alt="BeroBurny" src="https://github.com/BeroBurny.png" width="64"/>
524524
</a>
525525
</p>
526526

527527
<p>
528528
<a href="https://github.com/olejorgenb" target="_blank">
529529
<div><b>Ole Jørgen Brønner</b> (Oct 8, 2020)</div>
530-
<img src="https://github.com/olejorgenb.png" width="64"/>
530+
<img alt="olejorgenb" src="https://github.com/olejorgenb.png" width="64"/>
531531
</a>
532532
</p>
533533

534534
<p>
535535
<a href="https://github.com/pubkey/rxdb" target="_blank">
536536
<div><b>RxDB</b> (Apr 1, 2020)</div>
537-
<img src="https://cdn.rawgit.com/pubkey/rxdb/ba7c9b80/docs/files/logo/logo_text.svg" width="128" style="margin: -4px -10px"/>
537+
<img alt="RxDB" src="https://cdn.rawgit.com/pubkey/rxdb/ba7c9b80/docs/files/logo/logo_text.svg" width="128" style="margin: -4px -10px"/>
538538
</a>
539539
</p>
540540

541541
<p>
542542
<a href="https://github.com/Ziriax" target="_blank">
543543
<div><b>Peter Verswyvelen</b> (Feb 24, 2020)</div>
544-
<img src="https://github.com/Ziriax.png" width="64"/>
544+
<img alt="Ziriax" src="https://github.com/Ziriax.png" width="64"/>
545545
</a>
546546
</p>
547547

548548
<p>
549549
<a href="https://github.com/landonalder" target="_blank">
550550
<div><b>Landon Alder</b> (Mar 19, 2019)</div>
551-
<img src="https://github.com/landonalder.png" width="64"/>
551+
<img alt="landonalder" src="https://github.com/landonalder.png" width="64"/>
552552
</a>
553553
</p>
554554

0 commit comments

Comments
 (0)