Adds some explanation on how to use the script

2023-03-01 07:43:08 +00:00
parent 94e6fb6deb
commit 715956774a
1 changed files with 8 additions and 0 deletions
@@ -1,3 +1,11 @@
+/**
+ * This scripts creates example markdown files for the summary in the ./tmp folder.
+ * You can use it to preview changes to the summary.
+ *
+ * You can execute it like this:
+ * npx ts-node scripts/create_summary.ts
+ */
+
 import {Changes, ConfigurationOptions} from '../src/schemas'
 import {createTestChange} from '../__tests__/fixtures/create-test-change'
 import {InvalidLicenseChanges} from '../src/licenses'