docs: new API docs (#17)

Also:
* Update import types in JSDoc.
* Update CI/CD GitHub action.
* Update README; add badges / correct repo links.

.eslintignore

@@ -1,5 +1,6 @@
 coverage
 node_modules
+docs
 dist
 html
 !.*.js

.gitattributes

@@ -0,0 +1,6 @@
+# Set line endings / allows Windows checkout to pass Eslint rules.
+* text eol=lf
+
+# Denote all files that are truly binary and should not be modified.
+*.png binary
+*.jpg binary

.github/workflows/ci.yml

@@ -0,0 +1,39 @@
+name: CI/CD
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build-node:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        node-version: [16.x, 18.x, 20.x]
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Set up Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Run Tests
+        run: npm run test
+
+# Uncomment to add Codecov support / setup Codecov / add coverage badge to README
+#      - name: Upload coverage to Codecov
+#        uses: codecov/codecov-action@v3
+#        with:
+#          token: ${{ secrets.CODECOV_TOKEN }}
+#          flags: unittests

.gitignore

@@ -1,4 +1,5 @@
 node_modules
 coverage
+/.dts
 /html
 /.idea

CHANGES.md

@@ -10,8 +10,11 @@ Set to `preserve` to retain empty description lines.
 - feat: new properties in the `JsdocBlock` generated AST `delimiterLineBreak` and `preterminalLineBreak` that encode
 any line break after the opening `delimiter` and before the closing `terminal` string. Values are either `\n` or an
 empty string.
+
 - chore: update devDeps / switch to Vitest.
 
+- New [API documentation](https://es-joy.github.io/jsdoccomment/).
+
 Thanks:
 - [@typhonrt](https://github.com/typhonrt)
 

README.md

@@ -1,6 +1,10 @@
 # @es-joy/jsdoccomment
 
-[![Node.js CI status](https://github.com/brettz9/getJSDocComment/workflows/Node.js%20CI/badge.svg)](https://github.com/brettz9/getJSDocComment/actions)
+[![NPM](https://img.shields.io/npm/v/@es-joy/jsdoccomment.svg?label=npm)](https://www.npmjs.com/package/@es-joy/jsdoccomment)
+[![License](https://img.shields.io/badge/license-MIT-yellowgreen.svg?style=flat)](https://github.com/es-joy/jsdoccomment/blob/main/LICENSE-MIT.txt)
+[![Build Status](https://github.com/es-joy/jsdoccomment/workflows/CI/CD/badge.svg)](#)
+[![API Docs](https://img.shields.io/badge/API%20Documentation-476ff0)](https://es-joy.github.io/jsdoccomment/)
+
 
 This project aims to preserve and expand upon the
 `SourceCode#getJSDocComment` functionality of the deprecated ESLint method.
@@ -208,17 +212,17 @@ npm i @es-joy/jsdoccomment
 
 ## Changelog
 
-The changelog can be found on the [CHANGES.md](./CHANGES.md).
+The changelog can be found on the [CHANGES.md](https://github.com/es-joy/jsdoccomment/blob/main/CHANGES.md).
 <!--## Contributing
 
 Everyone is welcome to contribute. Please take a moment to review the [contributing guidelines](CONTRIBUTING.md).
 -->
 ## Authors and license
 
 [Brett Zamir](http://brett-zamir.me/) and
-[contributors](https://github.com/es-joy/jsdoc-eslint-parser/graphs/contributors).
+[contributors](https://github.com/es-joy/jsdoccomment/graphs/contributors).
 
-MIT License, see the included [LICENSE-MIT.txt](LICENSE-MIT.txt) file.
+MIT License, see the included [LICENSE-MIT.txt](https://github.com/es-joy/jsdoccomment/blob/main/LICENSE-MIT.txt) file.
 
 ## To-dos