docs: update ecosystem documentation

- Add IPFS integration details and examples
- Add architecture diagram showing service relationships
- Update integration examples with IPFS usage
- Update related projects in README and CONTRIBUTING.md

Author: vveerrgg

CONTRIBUTING.md

@@ -1,46 +1,87 @@
-# Contributing to nostr-dm-magiclink-middleware
+# Contributing to Nostr DM Magic Link Middleware
 
-We love your input! We want to make contributing to nostr-dm-magiclink-middleware as easy and transparent as possible, whether it's:
+First off, thank you for considering contributing to our Nostr ecosystem! This is an open-source project, and we love to receive contributions from our community.
 
-- Reporting a bug
-- Discussing the current state of the code
-- Submitting a fix
-- Proposing new features
-- Becoming a maintainer
+## Code of Conduct
 
-## We Develop with Github
-We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.
+This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code.
 
-## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html)
-Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:
+## How Can I Contribute?
 
-1. Fork the repo and create your branch from `main`.
-2. If you've added code that should be tested, add tests.
-3. If you've changed APIs, update the documentation.
-4. Ensure the test suite passes.
-5. Make sure your code lints.
-6. Issue that pull request!
+### Reporting Bugs
 
-## Any contributions you make will be under the MIT Software License
-In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.
+Before creating bug reports, please check the issue list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible:
 
-## Report bugs using Github's [issue tracker](https://github.com/HumanjavaEnterprises/nostr-dm.magiclink-middleware/issues)
-We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/HumanjavaEnterprises/nostr-dm.magiclink-middleware/issues/new); it's that easy!
+* Use a clear and descriptive title
+* Describe the exact steps which reproduce the problem
+* Provide specific examples to demonstrate the steps
+* Describe the behavior you observed after following the steps
+* Explain which behavior you expected to see instead and why
+* Include any error messages or logs
 
-## Write bug reports with detail, background, and sample code
+### Suggesting Enhancements
 
-**Great Bug Reports** tend to have:
+If you have a suggestion for a new feature or enhancement:
 
-- A quick summary and/or background
-- Steps to reproduce
-  - Be specific!
-  - Give sample code if you can.
-- What you expected would happen
-- What actually happens
-- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
+* Use a clear and descriptive title
+* Provide a step-by-step description of the suggested enhancement
+* Provide specific examples to demonstrate the steps
+* Describe the current behavior and explain which behavior you expected to see instead
+* Explain why this enhancement would be useful
+
+### Pull Requests
+
+* Fill in the required template
+* Do not include issue numbers in the PR title
+* Include screenshots and animated GIFs in your pull request whenever possible
+* Follow the TypeScript styleguide
+* Include thoughtfully-worded, well-structured tests
+* Document new code
+* End all files with a newline
+
+## Development Process
+
+1. Fork the repo and create your branch from `main`
+2. Run `npm install` to install dependencies
+3. Make your changes
+4. Add tests for any new functionality
+5. Run `npm test` to ensure nothing is broken
+6. Update documentation if needed
+7. Submit your pull request
+
+### Testing
+
+We use Jest for testing. Please ensure all tests pass before submitting a PR:
+
+```bash
+npm test
+```
+
+For more information about testing, see our [Testing Guide](docs/testing-nostr-services.md).
+
+### TypeScript
+
+This project is written in TypeScript. Please ensure your code:
+
+* Has proper type definitions
+* Doesn't use `any` unless absolutely necessary
+* Follows our existing patterns for generics and type safety
+
+### Commit Messages
+
+* Use the present tense ("Add feature" not "Added feature")
+* Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
+* Limit the first line to 72 characters or less
+* Reference issues and pull requests liberally after the first line
+
+## Related Projects
+
+This middleware is part of a larger Nostr ecosystem. Consider contributing to our related projects:
+
+* [nostr-auth-middleware](https://github.com/HumanjavaEnterprises/nostr-auth-middleware)
+* [nostr-relay-nestjs](https://github.com/HumanjavaEnterprises/nostr-relay-nestjs)
+* [ipfs-nostr-file-store](https://github.com/HumanjavaEnterprises/ipfs-nostr-file-store)
 
 ## License
-By contributing, you agree that your contributions will be licensed under its MIT License.
 
-## References
-This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md).
+By contributing, you agree that your contributions will be licensed under the MIT License.

README.md

@@ -10,6 +10,27 @@
 
 A middleware for handling magic link authentication via Nostr DMs. This package provides a secure way to implement passwordless authentication using Nostr's direct messaging system.
 
+## Part of the Nostr Ecosystem
+
+This middleware is part of a larger ecosystem of Nostr-related services:
+
+- [nostr-auth-middleware](https://github.com/HumanjavaEnterprises/nostr-auth-middleware) - Authentication middleware for Nostr
+- [nostr-dm-magiclink-middleware](https://github.com/HumanjavaEnterprises/nostr-dm.magiclink-middleware) - Magic link authentication via Nostr DMs (this package)
+- [nostr-relay-nestjs](https://github.com/HumanjavaEnterprises/nostr-relay-nestjs) - NestJS-based Nostr relay implementation
+- [ipfs-nostr-file-store](https://github.com/HumanjavaEnterprises/ipfs.nostr-file-store) - IPFS-based file storage for Nostr
+
+These services can be used independently or together to create a full-featured Nostr application stack:
+
+```mermaid
+graph TD
+    A[Client Application] --> B[nostr-auth-middleware]
+    A --> C[nostr-dm-magiclink-middleware]
+    B --> D[nostr-relay-nestjs]
+    C --> D
+    A --> E[ipfs-nostr-file-store]
+    D --> E
+```
+
 ## Features
 
 - 🔐 Secure magic link generation and verification
@@ -18,6 +39,8 @@ A middleware for handling magic link authentication via Nostr DMs. This package
 - 🚀 Easy integration with Express.js
 - 📦 TypeScript support
 - ⚡ Async/await API
+- 🤝 Works seamlessly with other Nostr services
+- 📁 Compatible with IPFS file storage
 
 ## Installation
 
@@ -64,6 +87,43 @@ process.on('SIGTERM', async () => {
 });
 ```
 
+## Integration Examples
+
+### With nostr-auth-middleware
+
+```typescript
+import { createNostrAuth } from 'nostr-auth-middleware';
+import { createNostrMagicLink } from 'nostr-dm-magiclink-middleware';
+
+const auth = createNostrAuth({ /* config */ });
+const magicLink = createNostrMagicLink({ /* config */ });
+
+app.use('/auth', auth.router);
+app.use('/magic-link', magicLink.router);
+```
+
+### With Custom Relay and IPFS
+
+```typescript
+import { createNostrMagicLink } from 'nostr-dm-magiclink-middleware';
+import { createIpfsNostrStore } from 'ipfs-nostr-file-store';
+
+const magicLink = createNostrMagicLink({
+  privateKey: process.env.NOSTR_PRIVATE_KEY!,
+  baseUrl: 'https://your-app.com/auth',
+  relayUrl: 'wss://your-relay.com', // Your nostr-relay-nestjs instance
+});
+
+const ipfsStore = createIpfsNostrStore({
+  ipfsNode: 'https://your-ipfs-node.com',
+  relayUrl: 'wss://your-relay.com',
+});
+
+// Now you can use both services together
+app.use('/auth', magicLink.router);
+app.use('/files', ipfsStore.router);
+```
+
 ## How It Works
 
 1. User requests login with their Nostr public key (npub)
@@ -80,32 +140,24 @@ process.on('SIGTERM', async () => {
 - ✅ Session-based verification
 - ✅ Automatic cleanup of expired sessions
 
-## Advanced Usage
-
-You can also use the services directly for more custom implementations:
-
-```typescript
-import { NostrService, MagicLinkService } from 'nostr-dm-magiclink-middleware';
-
-// Use NostrService directly for DM functionality
-const nostr = new NostrService(privateKey, relayUrl);
-
-// Use MagicLinkService for custom magic link handling
-const magicLink = new MagicLinkService(privateKey, baseUrl, relayUrl);
-```
-
 ## Documentation
 
 For detailed documentation, check out:
 
-- [Testing Nostr Services](docs/testing-nostr-services.md) - Learn about testing strategies, common challenges, and best practices for testing Nostr services
+- [Testing Nostr Services](docs/testing-nostr-services.md) - Learn about testing strategies, common challenges, and best practices
 - [API Reference](docs/api-reference.md) - Detailed API documentation
 - [Security Guide](docs/security-guide.md) - Security best practices and considerations
 
 ## Contributing
 
-Contributions are welcome! Please feel free to submit a Pull Request.
+Contributions are welcome! Please feel free to submit a Pull Request. Check out our [Contributing Guide](CONTRIBUTING.md) for more details.
+
+## Related Projects
+
+- [nostr-auth-middleware](https://github.com/HumanjavaEnterprises/nostr-auth-middleware)
+- [nostr-relay-nestjs](https://github.com/HumanjavaEnterprises/nostr-relay-nestjs)
+- [ipfs-nostr-file-store](https://github.com/HumanjavaEnterprises/ipfs.nostr-file-store)
 
 ## License
 
-MIT License - see LICENSE file for details
+MIT