@didcid/cipher 0.1.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Archetech
+
+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.

package/README.md

@@ -0,0 +1,38 @@
+# Archon cipher
+
+Archon cryptography utilities for encryption/decryption and creating/verifying signatures.
+
+## Installation
+
+```bash
+npm install @didcid/cipher
+```
+
+## Usage
+
+The cipher library comes in two versions for servers and web browsers.
+The classes are identical but have different package dependencies.
+
+### Node server applications
+
+```js
+// Import using subpaths
+import CipherNode from '@didcid/cipher/node';
+
+//Non-subpath import
+import CipherNode from '@didcid/cipher';
+
+const cipher = new CipherNode();
+```
+
+### Web browsers
+
+```js
+// Import using subpaths
+import CipherWeb from '@didcid/cipher/web';
+
+//Non-subpath import
+import CipherWeb from '@didcid/cipher';
+
+const cipher = new CipherWeb();
+```