Readme edit #78
Readme edit #78
Conversation
README.md
Outdated
|
|
||
| # About Us | ||
| For comprehensive and up-to-date guides, tutorials, and technical documentation, visit our [GitBook page](https://talsec.gitbook.io/freerasp). It serves as your go-to resource, offering everything from basic instructions to advanced tips and tricks to help you get the most out of our project. |
There was a problem hiding this comment.
I'd reference Gitbook right at the beginning. Either just rephrase the sentence, or put a new sencence at the beginning (whole sentence as a link), then newline, then current content.
README.md
Outdated
|
|
||
| Talsec is an academic-based and community-driven mobile security company. We deliver in-App Protection and a User Safety suite for Fintechs. We aim to bridge the gaps between the user's perception of app safety and the strong security requirements of the financial industry. | ||
| :link: For integrating it on the React Native platform, be sure to follow all the steps in our [Integration Guide](https://talsec.gitbook.io/freerasp/integration). This guide provides detailed instructions to help you achieve a smooth and efficient integration. |
There was a problem hiding this comment.
Integration is quite hidden there, I'd put it in a separate chapter before the Discover our GitBook Documentation part. Also please link directly react native integration. This is the most important thing in the readme, it should be emphasized more.
There was a problem hiding this comment.
I think the link to the general integration is a better option because there are steps that are also important. If I link them directly to the React Native integration, they won't do/read the steps on the general integration page. I discussed it with @msikyna.
README.md
Outdated
|
|
||
| This project is provided as freemium software i.e. there is a fair usage policy that impose some limitations on the free usage. The SDK software consists of opensource and binary part which is property of Talsec. The opensource part is licensed under the MIT License - see the [LICENSE](https://github.com/talsec/Free-RASP-Community/blob/master/LICENSE) file for details. | ||
| # Reference to Our Legacy Documentation | ||
| If you encounter any discrepancies or errors in the documentation, please let us know so we can improve it and ensure the best experience for all users. For information on older integration methods, you can refer to the [freeRASP wiki](https://github.com/talsec/Free-RASP-ReactNative/wiki), which includes comprehensive legacy details and guidance. We appreciate your feedback, as it helps us refine our resources and better support your needs. |
There was a problem hiding this comment.
The old integration can be found when you checkout to specific tag (up to currently latest one) - I think this would be nice to mention.
please let us know so we can improve it and ensure the best experience for all users.
This feels to me like we know there are issues and want community to help fix it. Please rephrase it a bit, so it feels like we are more confident about our docs :D
..., as it helps us refine our resources and better support your needs.
This sentence feels a bit too simple, could you try to improve it?
example from chatgpt: Your input is invaluable in helping us improve our resources and provide even better support for your needs.
README.md
Outdated
|
|
||
| Talsec is an academic-based and community-driven mobile security company. We deliver in-App Protection and a User Safety suite for Fintechs. We aim to bridge the gaps between the user's perception of app safety and the strong security requirements of the financial industry. | ||
| :link: For integrating it on the React Native platform, be sure to follow all the steps in our [Integration Guide](https://talsec.gitbook.io/freerasp/integration). This guide provides detailed instructions to help you achieve a smooth and efficient integration. |
There was a problem hiding this comment.
| :link: For integrating it on the React Native platform, be sure to follow all the steps in our [Integration Guide](https://talsec.gitbook.io/freerasp/integration). This guide provides detailed instructions to help you achieve a smooth and efficient integration. | |
| :link: For integrating freeRASP on the React Native platform, be sure to follow all the steps in our [Integration Guide](https://talsec.gitbook.io/freerasp/integration). This guide provides detailed instructions to help you achieve a smooth and efficient integration. |
Just last minor change, then it will be great 😄
There was a problem hiding this comment.
Okay, noted. 😄
Readme update