From e3317fe80a56971f08df822afa51db6de99699c0 Mon Sep 17 00:00:00 2001 From: isasharafdin Date: Sat, 3 Feb 2024 15:39:10 +0300 Subject: [PATCH] added readme and changed the security --- CONTRIBUTING.md | 1 + README.md | 27 ++++++++++++++++++++++++++- SECURITY.md | 2 +- 3 files changed, 28 insertions(+), 2 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..f7add826 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1 @@ +# CONTRIBUTING \ No newline at end of file diff --git a/README.md b/README.md index b2ea5d4b..8f22ce58 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,28 @@ # Yonode -Yonode - A Web Server Framework for Node.js +## Getting Started + +Visit our documentation to [get started with Yonode](https://docs.yonode.org). + +## Who is using Yonode? + +Yonode is trusted and utilized by developers around the globe, from individual contributors to large corporations. Discover how Yonode is being implemented in different projects by visiting our showcase. + +## Community + +Join the vibrant Yonode community: + +- **GitHub Discussions**: Engage in conversations, ask questions, share ideas, and showcase your projects. +- **Discord**: Connect and chat with fellow Yonode users and contributors. [Join](https://discord.com) + +## Contributing + +Interested in contributing to Yonode? Check out our [contributing guidelines](CONTRIBUTING.md). + +## License + +Yonode is an open-source package licensed under the [MIT License](LICENSE) + +## Security + +[Reporting a Vulnerability](SECURITY.md) \ No newline at end of file diff --git a/SECURITY.md b/SECURITY.md index ca1e18f6..34f95c70 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -1,5 +1,5 @@ Reporting a Vulnerability -To report a vulnerability, please open a private vulnerability report at https://github.com/sharafdin/yonode/security. +If you believe you have found a security vulnerability in Yonode, please report it to us responsibly. Do not open a public issue. We will investigate all legitimate reports. Send your report to [security@yonode.org](mailto:security@yonode.org). While the discovery of new vulnerabilities is rare, we also recommend always using the latest versions of Yonode and its official plugins to ensure your application remains as secure as possible.