Merge branch 'main' into 10-21-docs_add_a_roadmap_.md_file

README.md

@@ -9,9 +9,18 @@ SPDX-License-Identifier: MIT
 </p>
 
 <p align="center">
-    > Easily render markdown files in neovim
+    Easily render markdown files in neovim
 </p>
 
+[![License](https://img.shields.io/github/license/Imamiland/neovim-vivify-markdown.nvim)](https://github.com/Imamiland/neovim-vivify-markdown.nvim/blob/main/LICENSE)
+![Neovim Version](https://img.shields.io/badge/Neovim-0.8%20%7C%200.9%20%7C%20stable-blue)
+[![Continuous Integration](https://github.com/Imamiland/neovim-vivify-markdown.nvim/actions/workflows/ci.yaml/badge.svg)](https://github.com/Imamiland/neovim-vivify-markdown.nvim/actions/workflows/ci.yaml)
+[![GitHub release (latest by date)](https://img.shields.io/github/v/release/Imamiland/neovim-vivify-markdown.nvim)](https://github.com/Imamiland/neovim-vivify-markdown.nvim/releases/current)
+![GitHub Repo stars](https://img.shields.io/github/stars/Imamiland/neovim-vivify-markdown.nvim)
+![code style: stylua](https://img.shields.io/badge/code%20style-stylua-blue)
+[![REUSE status](https://api.reuse.software/badge/github.com/Imamiland/neovim-vivify-markdown.nvim)](https://api.reuse.software/info/github.com/Imamiland/neovim-vivify-markdown.nvim)
+[![OpenSSF Best Practices](https://bestpractices.coreinfrastructure.org/projects/9597/badge)](https://bestpractices.coreinfrastructure.org/projects/9597)
+
 <!--<div align="center">-->
 <!--    > Drag your video (<10MB) here to host it for free on GitHub.-->
 <!--</div>-->
@@ -131,8 +140,8 @@ We welcome all contributions. Please look at [CONTRIBUTING](CONTRIBUTING.md) to
 
 ## Motivations
 
-> If alternatives of your plugin exist, you can provide some pros/cons of using yours over the others.
+This project is heavily inspired by the neovim plugin by [https://github.com/iamcco/markdown-preview.nvim](https://github.com/iamcco/markdown-preview.nvim) and [https://github.com/jannis-baum/vivify.vim](https://github.com/jannis-baum/vivify.vim). Of course, it would not exist without [Vivify](https://github.com/jannis-baum/vivify).
 
 ## License
 
-This project is licensed under the [MIT License](LICENSES/MIT.txt). Some ancillary files are licensed under the [Creative Commons Zero](LICENSES/CC0-1.0.txt) License and are dedicated to the Public Domain.
+This project is licensed under the [MIT License](LICENSES/MIT.txt). Some ancillary files are licensed under the [Creative Commons Zero](LICENSES/CC0-1.0.txt) and are dedicated to the Public Domain.

SECURITY.md

@@ -0,0 +1,38 @@
+<!--
+SPDX-FileCopyrightText: 2024 Ali Sajid Imami
+
+SPDX-License-Identifier: MIT
+-->
+
+# Security Policy
+
+## Supported Versions
+
+This plugin will always support the **current** and **previous three releases** of Neovim. The plugin may have an irregular release schedule, so please ensure your Neovim version is within the supported range to receive updates and fixes.
+
+| Neovim Version | Supported          |
+| -------------- | ------------------ |
+| Nightly        | :white_check_mark: |
+| Stable         | :white_check_mark: |
+| Stable - 1     | :white_check_mark: |
+| Stable - 2     | :white_check_mark: |
+| Stable - 3     | :white_check_mark: |
+| Older versions | :x:                |
+
+## Reporting a Vulnerability
+
+If you discover any security vulnerabilities or potential issues, please follow these steps to report them:
+
+1. **Do not publicly disclose** the vulnerability until a fix is available.
+2. Email [security@email.imamiland.com](mailto:security@email.imamiland.com) with details of the vulnerability, including:
+   - Steps to reproduce the issue.
+   - A detailed description of the security impact.
+   - Potential fixes or recommendations if available.
+3. You will receive an acknowledgment within **48 hours** of your report.
+
+Once the issue has been assessed, we will provide a timeline for a fix and release. Security patches will be backported for all supported versions of Neovim.
+
+## Vulnerability Disclosure Timeline
+
+- We aim to resolve critical vulnerabilities within **7 days** of being reported.
+- Non-critical vulnerabilities will be handled during regular development cycles and addressed in future updates.