-
Notifications
You must be signed in to change notification settings - Fork 9
Edits to Index page #6
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -6,32 +6,41 @@ sidebar_position: 1 | |||||
|
|
||||||
| **An Enterprise-Grade, Bidirectional SWIFT MT ↔ ISO 20022 Transformation Engine** | ||||||
|
|
||||||
| Reframe is the world's first completely transparent, open-source platform for high-performance SWIFT message transformation. | ||||||
| Reframe is the world's first completely transparent, open-source platform for high-performance SWIFT message transformation. In the evolving world of financial messaging, clarity and control are non-negotiable. Reframe provides a powerful, open-source alternative to proprietary, black-box solutions for SWIFT MT and ISO 20022 transformation. It's designed for financial institutions that demand auditable logic, elite performance, and complete control over their messaging workflows. | ||||||
|
|
||||||
| ## Why Reframe? | ||||||
| Reframe is designed to be: | ||||||
|
|
||||||
| In the evolving world of financial messaging, clarity and control are non-negotiable. **Reframe** was built to provide a powerful, open-source alternative to proprietary, black-box solutions for SWIFT MT and ISO 20022 transformation. It's designed for financial institutions that demand **auditable logic**, **elite performance**, and **complete control** over their messaging workflows. | ||||||
|
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I have removed bold formatting since it is usually reserved for UI elements. To emphasize the word, italics could be used. |
||||||
| - **Transparent**: Say goodbye to black boxes. Every transformation rule is defined in human-readable JSON and is fully auditable. | ||||||
| - **Performant**: Built in Rust, it delivers sub-millisecond processing speeds, ensuring your operations are never bottlenecked. | ||||||
| - **Configurable**: Define your business logic and mappings with a JSON-based configuration system. | ||||||
| - **Extensible**: Customize or extend Reframe with a modular, pluggable architecture to meet your specific needs. | ||||||
|
Comment on lines
+14
to
+16
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. To follow parallelism, I have rewritten this sentence starting with a verb. This approach can be applied consistently across the docs. |
||||||
|
|
||||||
| - **Full Transparency**: Say goodbye to black boxes. Every transformation rule is defined in human-readable JSON and is fully auditable. | ||||||
| - **Blazing-Fast Performance**: Built in Rust, Reframe delivers sub-millisecond processing speeds, ensuring your operations are never bottlenecked. | ||||||
| - **Total Configurability**: Define your own business logic and mappings with a simple yet powerful JSON-based configuration system. | ||||||
| - **Extensible by Design**: A modular, pluggable architecture makes it easy to customize or extend Reframe to meet your specific needs. | ||||||
| # Security & Compliance | ||||||
|
|
||||||
| Reframe is built with the stringent requirements of financial institutions in mind. | ||||||
|
|
||||||
| - **Secure by Design**: Follows security best practices from the ground up. | ||||||
| - **Compliance-Ready**: Supports environments requiring PCI, SOX, and Basel III compliance. | ||||||
| - **Full Audit Trail**: Provides complete logging and traceability for every transformation. | ||||||
| - **Proactive Security**: Monitors vulnerabilities actively and provides regular security updates. | ||||||
|
Comment on lines
+18
to
+25
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Moved the content from the bottom for better reading flow. |
||||||
|
|
||||||
| ## Key Features | ||||||
|
|
||||||
| They key features include: | ||||||
|
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Added a leading sentence between two headings to provide context rather than presenting back to back heading without explanation. |
||||||
|
|
||||||
| ### Core Transformation Engine | ||||||
|
|
||||||
| - **True Bidirectional Processing**: Seamlessly transform messages both ways: | ||||||
| - **True Bidirectional Processing**: Transforms messages seamlessly both ways: | ||||||
| - **Forward**: SWIFT MT → ISO 20022 (MX) | ||||||
| - **Reverse**: ISO 20022 (MX) → SWIFT MT | ||||||
| - **Comprehensive Message Support**: 44+ pre-configured transformation scenarios covering payments, cash management, status reporting, and administrative messages. | ||||||
| - **Intelligent Routing**: Automatic message type detection and routing to the correct transformation workflow. | ||||||
| - **Comprehensive Message Support**: Includes 44+ pre-configured transformation scenarios covering payments, cash management, status reporting, and administrative messages. | ||||||
| - **Intelligent Routing**: Detects message type automatically and routes to the correct transformation workflow. | ||||||
|
Comment on lines
+33
to
+37
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. As mentioned above, for parallelism rewrote the bullet points. |
||||||
|
|
||||||
| ### Built for the Enterprise | ||||||
| ### Built for Enterprise | ||||||
|
|
||||||
| - **High Availability**: A stateless, container-native architecture allows for effortless horizontal scaling. | ||||||
| - **Zero-Downtime Updates**: Hot-reload configurations and workflows on the fly via an API endpoint, no service restarts required. | ||||||
| - **Production-Ready**: Comes with comprehensive error handling, monitoring, and observability baked in. | ||||||
| - **Zero-Downtime Updates**: Hot-reload configurations and workflows on the fly via an API endpoint—no service restarts required. | ||||||
| - **Production-Ready**: Comes with comprehensive error handling, monitoring, and observability. | ||||||
| - **Simple Deployment**: Ships as a single, lightweight Docker image for easy deployment in any environment. | ||||||
|
|
||||||
| ### Unmatched Transparency & Control | ||||||
|
|
@@ -40,51 +49,54 @@ In the evolving world of financial messaging, clarity and control are non-negoti | |||||
| - **Powerful Workflow Engine**: Backed by a sophisticated dataflow engine ([dataflow-rs](https://github.com/GoPlasmatic/dataflow-rs)) to model complex processing pipelines. | ||||||
| - **Declarative Logic**: Utilizes [datalogic-rs](https://github.com/GoPlasmatic/datalogic-rs) to enable powerful and clear declarative logic for complex field mappings. | ||||||
|
|
||||||
| ## How Reframe Compares | ||||||
| ## Reframe verses Traditional Solutions | ||||||
|
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Rewrote to avoid starting a heading with question to align better with document standards. I would suggest using declarative statments. |
||||||
|
|
||||||
| | Feature | Reframe | Traditional Solutions | | ||||||
| | -------------------- | --------------------------------------------- | ------------------------------------- | | ||||||
| | **Transparency** | ✅ Open source with 100% auditable JSON rules | ❌ Proprietary, black-box logic | | ||||||
| | **Transformation** | ✅ Fully bidirectional (MT ↔ MX) | ❌ Often one-way or limited reverse | | ||||||
| | **Transformation** | ✅ Bidirectional (MT ↔ MX) | ❌ Often one-way or limited reverse | | ||||||
|
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is just an example to show that we can avoid using adjectives |
||||||
| | **Performance** | ✅ Rust-powered (sub-millisecond) | ❌ Slower, often JVM-based | | ||||||
| | **Configuration** | ✅ Hot-reloadable JSON, no downtime | ❌ Requires vendor intervention | | ||||||
| | **License** | ✅ Apache 2.0 (Free to use and modify) | ❌ Expensive, restrictive licensing | | ||||||
| | **Deployment** | ✅ Lightweight, single Docker container | ❌ Heavy, complex infrastructure | | ||||||
| | **SR2025 Compliance** | ✅ Full compliance with November 2025 release | ❌ Limited or delayed support | | ||||||
| | **CBPR+ Support** | ✅ Enhanced CBPR+ capabilities | ❌ Basic or partial implementation | | ||||||
|
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. To avoid visual clutter, the checks and crosses can be removed. Also, it would not change the meaning when removed.
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It's good practice to spell out the first instance of an acronym.
Suggested change
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @shankar-gpio, just checking in to see if there is any update on the assignment. Would appreciate it if you could let me know the status when you get a chance. |
||||||
|
|
||||||
| ## Get Started in Minutes | ||||||
| ## Getting Started | ||||||
|
|
||||||
| You can get started in the following ways: | ||||||
|
|
||||||
| ### With Docker (Recommended) | ||||||
| ### With Docker | ||||||
|
|
||||||
| The fastest way to get Reframe running. | ||||||
| This is the fastest and recommended way to get Reframe running. | ||||||
|
|
||||||
| ```bash | ||||||
| # Pull the latest image from Docker Hub | ||||||
| 1. Pull the latest image from Docker Hub | ||||||
|
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. When a process involves step procedures, use a numbered list instead. |
||||||
| docker pull plasmatic/reframe:latest | ||||||
|
|
||||||
| # Run the container and expose the API on port 3000 | ||||||
| 2. Run the container and expose the API on port 3000 | ||||||
| docker run -p 3000:3000 plasmatic/reframe:latest | ||||||
|
|
||||||
| # The API is now live and waiting for requests at http://localhost:3000 | ||||||
| The API is now live and waiting for requests at http://localhost:3000 | ||||||
|
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is the result of the previous step and it need not be a numbered list. |
||||||
| ``` | ||||||
|
|
||||||
| ### From Source | ||||||
| For developers who want to build from the ground up. | ||||||
|
|
||||||
| Developers building from the ground up can use this method. | ||||||
|
|
||||||
| ```bash | ||||||
| # 1. Clone the repository | ||||||
| 1. Clone the repository | ||||||
| git clone https://github.com/GoPlasmatic/Reframe.git | ||||||
| cd Reframe | ||||||
|
|
||||||
| # 2. Build the project in release mode (optimized for performance) | ||||||
| 2. Build the project in release mode (optimized for performance) | ||||||
| cargo build --release | ||||||
|
|
||||||
| # 3. Run the application | ||||||
| 3. Run the application | ||||||
| ./target/release/reframe | ||||||
| ``` | ||||||
|
|
||||||
| ### Try It Now | ||||||
| ### Try Now | ||||||
|
|
||||||
| Use curl to send your first transformation request. | ||||||
|
|
||||||
| ```bash | ||||||
|
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The following could be individual code blocks so it is easier to copy each sample code |
||||||
|
|
@@ -127,20 +139,12 @@ Our vision is to make Reframe the undisputed backbone for financial messaging. | |||||
| - **OpenAPI Documentation**: Auto-generated API documentation with Swagger UI. | ||||||
| - **Dual-Engine Architecture**: Optimized forward and reverse transformation engines. | ||||||
|
|
||||||
| ## Security & Compliance | ||||||
|
|
||||||
| We built Reframe with the stringent requirements of financial institutions in mind. | ||||||
|
|
||||||
| - **Secure by Design**: Follows security best practices from the ground up. | ||||||
| - **Compliance-Ready**: Architected to support environments requiring PCI, SOX, and Basel III compliance. | ||||||
| - **Full Audit Trail**: Provides complete logging and traceability for every transformation. | ||||||
| - **Proactive Security**: We actively monitor for vulnerabilities and provide regular security updates. | ||||||
|
|
||||||
| ## License | ||||||
|
|
||||||
| Reframe is licensed under the Apache License, Version 2.0. You are free to use, modify, and distribute it. See [LICENSE](LICENSE) for more details. | ||||||
| Reframe is licensed under the Apache License, Version 2.0. You are free to use, modify, and distribute it. For more details, see [LICENSE](LICENSE). | ||||||
|
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The link is broken and needs to be corrected |
||||||
|
|
||||||
| --- | ||||||
|
|
||||||
| **Built by Plasmatic** | ||||||
| Making financial messaging transparent, fast, and reliable. | ||||||
| Making financial messaging transparent, fast, and reliable. | ||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For a better reading flow, I have removed this heading.