-
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?
Edits to Index page #6
Conversation
Neethujoymathew
left a comment
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.
Minor formatting and language adjustments were made to improve readability. These are some of the sample edits. I would have made additional improvments with better product knowledge.
| 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? |
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.
| ## 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. |
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.
I have removed bold formatting since it is usually reserved for UI elements. To emphasize the word, italics could be used.
| - **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. |
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.
To follow parallelism, I have rewritten this sentence starting with a verb. This approach can be applied consistently across the docs.
I have also removed the adjectives since it sounded more suited to the marketing content than technical documentation
| # 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. |
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.
Moved the content from the bottom for better reading flow.
|
|
||
| ## Key Features | ||
|
|
||
| They key features include: |
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.
Added a leading sentence between two headings to provide context rather than presenting back to back heading without explanation.
| | **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 | |
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.
To avoid visual clutter, the checks and crosses can be removed. Also, it would not change the meaning when removed.
|
|
||
| ```bash | ||
| # Pull the latest image from Docker Hub | ||
| 1. Pull the latest image from Docker Hub |
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.
When a process involves step procedures, use a numbered list instead.
| 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 |
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.
This is the result of the previous step and it need not be a numbered list.
| ## 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). |
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.
The link is broken and needs to be corrected
|
|
||
| Use curl to send your first transformation request. | ||
|
|
||
| ```bash |
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.
The following could be individual code blocks so it is easier to copy each sample code
|
Thanks for your contribution. Let me review the details and update soon. |
| | **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 | |
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.
It's good practice to spell out the first instance of an acronym.
| | **CBPR+ Support** | ✅ Enhanced CBPR+ capabilities | ❌ Basic or partial implementation | | |
| | **Cross-Border Payments and Reporting Plus (CBPR+) Support** | ✅ Enhanced CBPR+ capabilities | ❌ Basic or partial implementation | |
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.
@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.
Thank you !
No description provided.