chore(docs): Replace Jekyll docs with better README (#409)

.github/dependabot.yml

@@ -8,7 +8,3 @@ updates:
   commit-message:
     prefix: "fix(deps):"
     prefix-development: "chore(deps):"
-- package-ecosystem: bundler
-  directory: "/docs"
-  schedule:
-    interval: weekly

.github/workflows/ci.yml

@@ -11,6 +11,6 @@ jobs:
     needs: ci
     uses: relaycorp/shared-workflows/.github/workflows/nodejs-lib-release.yml@main
     with:
-      jekyll_docs: true
+      api_docs: true
     secrets:
       npm_token: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -3,9 +3,3 @@ build
 test
 src/**.js
 coverage
-
-docs/.bundle
-docs/.jekyll-cache
-docs/.sass-cache
-docs/_site
-docs/vendor

.npmignore

@@ -1,6 +1,4 @@
 src
-docs/
-build/docs
 *.log
 
 jest.*.js

README.md

@@ -1,6 +1,30 @@
 # relaynet-core-js
 
-[![Known Vulnerabilities](https://snyk.io//test/github/relaycorp/relaynet-core-js/badge.svg?targetFile=package.json)](https://snyk.io//test/github/relaycorp/relaynet-core-js?targetFile=package.json)
-[![npm](https://img.shields.io/npm/v/@relaycorp/relaynet-core)](https://www.npmjs.com/package/@relaycorp/relaynet-core)
+This library implements the core of [Awala](https://awala.network) and is meant to be used by anyone using the network from a Node.js application. [Read the docs online](https://docs.relaycorp.tech/relaynet-core-js/).
 
-JavaScript library for the core of Relaynet. [Read the docs online](https://docs.relaycorp.tech/relaynet-core-js/).
+Please note that this documentation is mostly incomplete because the interface exposed by this library is changing rapidly as of this writing.
+
+## Install
+
+`@relaycorp/relaynet-core` requires Node.js v12 or newer, and the latest stable release can be installed as follows:
+
+```
+npm install --save @relaycorp/relaynet-core
+```
+
+## Specs supported
+
+This library supports the following Awala specs:
+
+- [RS-000 (Awala Core)](https://specs.awala.network/RS-000).
+- [RS-001 (RAMF v1)](https://specs.awala.network/RS-001).
+- [RS-002 (Awala PKI)](https://specs.awala.network/RS-002).
+- [RS-003 (Awala Channel Session Protocol)](https://specs.awala.network/RS-003).
+- [RS-018 (Awala Cryptographic Algorithms, Version 1)](https://specs.awala.network/RS-018). In addition to the required algorithms, the following are also supported:
+  - Hashing functions: SHA-384 and SHA-512.
+  - Ciphers: AES-192 and AES-256.
+  - ECDH curves: P-384 and P-521.
+
+## Updates
+
+Releases are automatically published on GitHub and NPM, and the [changelog can be found on GitHub](https://github.com/relaycorp/relaynet-core-js/releases). This project uses [semantic versioning](https://semver.org/).