docs: add license and readme (#13)

The necessary documentation is added to be moved to the Express
organization

closes #12

---------

Co-authored-by: Filip Kudła <[email protected]>

Author: bjohansebas

.github/actions/generate-help-docs.mjs

@@ -0,0 +1,22 @@
+import { execSync } from 'node:child_process'
+import { readFile, writeFile } from 'node:fs/promises'
+import { join } from 'node:path'
+
+let output = execSync('node ../../index.js --help', {
+  encoding: 'utf-8',
+})
+
+output = output.replace(
+  /(?<=Usage: @expressjs\/codemod \[codemod\] \[source\] \[options\]\n\n)[\s\S]*?(?=Options:)/,
+  '',
+)
+
+const readmePath = join('..', '..', 'README.md')
+const readme = await readFile(readmePath, 'utf-8')
+
+const updatedReadme = readme.replace(
+  /(?<=<!-- GENERATED START -->\n\n```\n)[\s\S]*?(?=```\n\n<!-- GENERATED END -->)/,
+  output,
+)
+
+await writeFile(readmePath, updatedReadme, 'utf-8')

.github/workflows/generate-readme.yml

@@ -0,0 +1,44 @@
+name: Generate dynamic README
+
+on:
+  push:
+    branches:
+      - main
+    paths: 
+      - index.ts
+
+jobs:
+  generate-readme:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '22'
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Build package
+        run: npm run build
+
+      - name: Run script
+        working-directory: .github/actions
+        run: node ./generate-help-docs.mjs
+
+      - name: Create Pull Request
+        uses: gr2m/create-or-update-pull-request-action@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+            title: 'Update options in README'
+            commit-message: 'chore: update README'
+            branch: readme-${{ github.sha }}
+            body: >
+                'Update the available options of the package in the CLI'

LICENSE

@@ -0,0 +1,23 @@
+(The MIT License)
+
+Copyright (c) 2024 Sebastian Beltran <[email protected]>
+Copyright (c) 2024 Filip Kudla <[email protected]>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,62 @@
+# @expressjs/codemod
+
+[![NPM Version][npm-version-image]][npm-url]
+[![NPM Install Size][npm-install-size-image]][npm-install-size-url]
+[![NPM Downloads][npm-downloads-image]][npm-downloads-url]
+[![OpenSSF Scorecard Badge][ossf-scorecard-badge]][ossf-scorecard-visualizer]
+
+Express.js provides Codemod transforms to help you upgrade your express server when a feature is deprecated or removed.
+
+Codemods are transformations that run on your codebase programmatically. This allows for a large amount of changes to be applied without having to manually go through every file.
+
+## Installation
+
+You don't need to install this package, run the following command:
+
+```sh
+npx @expressjs/codemod # or pnpx, bunx, etc.
+```
+
+or install globally:
+
+```sh
+npm i -g @expressjs/codemod # or pnpm, bun, etc.
+```
+
+## Usage
+
+Use `@expressjs/codemod -h` to explore available command-line options.
+
+<!-- GENERATED START -->
+
+```
+Usage: @expressjs/codemod [codemod] [source] [options]
+
+Options:
+  -v, --version  Output the current version of @expressjs/codemod.
+  -d, --dry      Dry run (no changes are made to files)
+  -h, --help     Display this help message.
+```
+
+<!-- GENERATED END -->
+
+##  Contributing
+
+The Express.js project welcomes all constructive contributions. Contributions take many forms,
+from code for bug fixes and enhancements, to additions and fixes to documentation, additional
+tests, triaging incoming pull requests and issues, and more!
+
+See the [Contributing Guide](https://github.com/expressjs/express/blob/master/Contributing.md) for more technical details on contributing.
+
+## License
+
+[MIT](LICENSE)
+
+[npm-downloads-image]: https://badgen.net/npm/dm/@expressjs/codemod
+[npm-downloads-url]: https://npmcharts.com/compare/@expressjs/codemod?minimal=true
+[npm-install-size-image]: https://badgen.net/packagephobia/install/@expressjs/codemod
+[npm-install-size-url]: https://packagephobia.com/result?p=@expressjs/codemod
+[npm-url]: https://npmjs.org/package/@expressjs/codemod
+[npm-version-image]: https://badgen.net/npm/v/@expressjs/codemod
+[ossf-scorecard-badge]: https://api.scorecard.dev/projects/github.com/expressjs/codemod/badge
+[ossf-scorecard-visualizer]: https://ossf.github.io/scorecard-visualizer/#/projects/github.com/expressjs/codemod

package.json

@@ -4,7 +4,7 @@
   "version": "0.0.1",
   "description": "Codemods for updating express servers.",
   "main": "index.js",
-  "author": "Sebastian Beltran <[email protected]>",
+  "contributors": ["Sebastian Beltran <[email protected]>", "Filip Kudla <[email protected]>"],
   "license": "MIT",
   "bin": "./index.js",
   "files": ["transforms/*.js", "commands/*.js", "utils/*.js", "config.js", "index.js"],