feat: added docs

Author: proohit

README.md

@@ -12,6 +12,8 @@
 
 A node wrapper for the [Netcup CCP API](https://www.netcup-wiki.de/wiki/CCP_API).
 
+Docs: [https://proohit.github.io/netcup-node/](https://proohit.github.io/netcup-node/)
+
 ## Current support
 
 - only [JSON Rest API](https://www.netcup-wiki.de/wiki/CCP_API#Anmerkungen_zu_JSON-Requests), no SOAP yet
@@ -100,81 +102,3 @@ const api = await new NetcupApi().init({
 });
 const dnsInfo = await api.infoDnsZone({ domainname: 'YOUR.DOMAIN' });
 ```
-
-### Reference
-
-```javascript
-/**
- * Initializes authentication parameters
- */
-NetcupApi.init({
-  apikey: 'YOUR_API_KEY',
-  apipassword: 'YOUR_API_PASSWORD',
-  customernumber: 'YOUR_CUSTOMER_NUMBER',
-});
-
-/**
- * Retrieves information about a DNS zone
- * */
-NetcupApi.infoDnsZone({
-  domainname: 'YOUR.DOMAIN',
-});
-
-/**
- * Retrieves information about DNS records of a domain
- * */
-NetcupApi.infoDnsRecords({
-  domainname: 'YOUR.DOMAIN',
-});
-
-/**
- * Updates DNS records of a domain and only those that are specified.
- */
-NetcupApi.updateDnsRecords({
-  domainname: 'example.com',
-  dnsrecordset: {
-    dnsrecords: [{ name: 'www', type: 'A', destination: 'some-ip' }],
-  },
-});
-// can also be used for deletion
-NetcupApi.updateDnsRecords({
-  domainname: 'example.com',
-  dnsrecordset: {
-    dnsrecords: [
-      { name: 'www', type: 'A', destination: 'some-ip', deleterecord: true },
-    ],
-  },
-});
-
-/**
- * Updates DNS records of a domain with the current public ip.
- * @example
- * // update ipv4 only
- * await api.updateDnsRecordsWithCurrentIp({ domainname: 'example.com', dnsrecords: [{ hostname: 'www' }] })
- * @example
- *  // update ipv4 and ipv6
- *  await api.updateDnsRecordsWithCurrentIp({ domainname: 'example.com', dnsrecords: [{ hostname: 'www' }], useIpv4AndIpv6: true })
- * @example
- * // update ipv6 only
- * await api.updateDnsRecordsWithCurrentIp({ domainname: 'example.com', dnsrecords: [{ hostname: 'www' }], useIpv6Only: true })
- */
-// update ipv4 only
-NetcupApi.updateDnsRecordWithCurrentIp({
-  domainname: 'example.com',
-  dnsrecordset: { dnsrecords: [{ hostname: 'www' }] },
-});
-
-// update ipv4 and ipv6
-NetcupApi.updateDnsRecordWithCurrentIp({
-  domainname: 'example.com',
-  dnsrecordset: { dnsrecords: [{ hostname: 'www' }] },
-  useIpv4AndIpv6: true,
-});
-
-// update ipv6 only
-NetcupApi.updateDnsRecordWithCurrentIp({
-  domainname: 'example.com',
-  dnsrecordset: { dnsrecords: [{ hostname: 'www' }] },
-  useIpv6Only: true,
-});
-```

package-lock.json

@@ -26,7 +26,9 @@
     "lint": "eslint . --ext .ts,.tsx",
     "test": "jest --coverage",
     "test:watch": "jest --watch",
-    "prerelease": "npm run build",
+    "docs": "typedoc src/index.ts",
+    "docs:release": "npm run docs && git add docs && git commit -m 'chore: update docs'",
+    "prerelease": "npm run build && npm run docs:release",
     "release": "npm login && bump --tag && npm publish",
     "postrelease": "git push && git push --tags"
   },
@@ -64,10 +66,11 @@
     "ts-jest": "^27.1.4",
     "tsc-esm-fix": "^2.13.0",
     "tsutils": "^3.21.0",
+    "typedoc": "^0.23.21",
     "typescript": "^4.6.3",
     "version-bump-prompt": "^6.1.0"
   },
   "engines": {
     "node": ">= 12.20"
   }
-}
+}