microfed 0.0.6 → 0.0.8

package/AUTHENTICATION.md

@@ -0,0 +1,16 @@
+# 🛡️ Authentication Module
+
+The Authentication Module is designed to offer a flexible and extensible authentication system for the ActivityPub-based inbox, ensuring secure and reliable access for users.
+
+## Key Features
+
+The Authentication Module provides the following capabilities:
+
+- A **base authentication class**, which serves as a foundation for implementing different authentication methods to cater to various needs and requirements.
+- **Support for PKI-based strong authentication**, ensuring a high level of security for user access and communication.
+- **Delegated authentication support**, such as OAuth and OIDC, providing the ability to incorporate third-party authentication services when necessary or desired.
+- **Integration with enterprise authentication systems**, allowing seamless authentication experiences for users within organizational environments.
+
+## Extensibility and Adaptability
+
+The Authentication Module has been designed with extensibility and adaptability in mind. It allows for the easy addition of different authentication modules as needed, ensuring that the system remains flexible and accommodating to various use cases and scenarios. This design philosophy ensures that the Authentication Module can evolve and adapt to changing requirements and security landscapes, providing a robust and future-proof authentication solution for your ActivityPub-based inbox.

package/OUTBOX.md

@@ -0,0 +1,33 @@
+# 📤 Outbox Module
+
+The Outbox Module is a critical component of the Microfed project, focusing on the efficient management of outgoing messages and ensuring secure communication with other inboxes in the fediverse. Its seamless integration with the ActivityPub protocol guarantees a smooth and intuitive user experience.
+
+## Overview
+
+The Outbox Module offers a comprehensive solution for handling a user's outbox in a Microfed environment, providing a range of features, including:
+
+- A dedicated class representing a user's outbox
+- Sending messages to other inboxes
+- Storage and management of private keys
+- Signing outgoing messages for enhanced security
+- Routing messages to appropriate endpoints
+
+## 📤 User Outbox Class
+
+At the core of the Outbox Module is a class specifically designed to represent a user's outbox. This class manages the creation, processing, and sending of outgoing messages, ensuring that users can easily interact with their outboxes in a consistent and structured manner.
+
+## 🔐 Private Key Management
+
+The Outbox Module includes methods for storing and managing private keys on behalf of users. By securely handling private keys, the module helps maintain the confidentiality of users' sensitive information and ensures robust security when communicating with other inboxes.
+
+## ✍️ Message Signing
+
+To further enhance the security and authenticity of outgoing messages, the Outbox Module supports message signing. By signing messages with a user's private key, recipients can verify the authenticity of the message, protecting against potential phishing attempts or other malicious activities.
+
+## 🚀 Message Routing
+
+The Outbox Module ensures that messages are correctly routed to their intended recipients by providing support for determining appropriate endpoints. This functionality guarantees that messages are delivered efficiently and accurately, enhancing the overall user experience.
+
+---
+
+The Outbox Module has been carefully designed to offer an outstanding user experience when interacting with the Microfed environment. Its powerful features and seamless integration with ActivityPub make it an essential part of the Microfed ecosystem.

package/UTILS.md

@@ -0,0 +1,20 @@
+# 🛠️ Utils Module
+
+The Utils Module is designed to provide a collection of utility functions and tools that support and enhance the functionality of the Microfed system, including the Profile, Inbox, Outbox, and Authentication modules.
+
+## Key Features
+
+The Utils Module offers the following essential utilities and tools:
+
+- **Data validation and sanitization**, ensuring that user data is correct, secure, and free from malicious input.
+- **Error handling and logging**, providing a structured approach to manage exceptions and log crucial information for debugging and maintenance purposes.
+- **Cryptography and security helpers**, offering a collection of tools for managing encryption, decryption, signing, and verification tasks.
+- **Networking and protocol utilities**, assisting with the handling of various networking tasks and protocol-specific operations.
+- **Message formatting and parsing**, delivering support for transforming and interpreting messages in different formats, such as JSON, JSON-LD, and others.
+- **Compatibility and integration tools**, enabling seamless interoperability between various components, modules, and third-party systems.
+
+## Modularity and Reusability
+
+The Utils Module is built with modularity and reusability in mind. Each utility function and tool is designed to be easily accessible and adaptable, allowing developers to quickly integrate them into their projects without any hassle. This design approach ensures that the Utils Module remains a valuable resource for the Microfed ecosystem, providing essential support and enhancing the functionality of the core modules.
+
+By offering a comprehensive set of utilities, the Utils Module empowers developers to focus on implementing the unique features and requirements of their specific projects, knowing that they have a reliable set of tools to support their work. This ultimately leads to more efficient development cycles and higher-quality end products.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "microfed",
-  "version": "0.0.6",
+  "version": "0.0.8",
   "description": "microfed",
   "main": "index.js",
   "scripts": {