Feature/ci cd (#9)

* Improved readme formatting, updated license, and updated git repo url

* Updated readme header

* Added linting to workflow

* Added note about slnx files

Author: xentropic-dev

.github/workflows/ci.yml

@@ -1,29 +1,41 @@
-name: Tests
+name: Lint and Test
 on:
   - push
   - pull_request
 jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup
+        run: |
+          sudo apt-get update
+          sudo apt-get install luarocks
+          sudo luarocks install luacheck
+      - name: Lint
+        run: luacheck lua/ --globals vim
   unit_tests:
-    name: unit tests
+    name: Unit Tests
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
       matrix:
         os:
-          - ubuntu-22.04
+          - ubuntu-latest
           - macos-latest
-          - windows-2022
+          - windows-latest
         rev:
           - nightly
           - v0.9.5
           - v0.10.0
         include:
-          - os: ubuntu-22.04
-            install-rg: sudo apt-get update && sudo apt-get install -y ripgrep
+          - os: ubuntu-latest
+            install-deps: sudo apt-get update && sudo apt-get install -y ripgrep
           - os: macos-latest
-            install-rg: brew update && brew install ripgrep
-          - os: windows-2022
-            install-rg: choco install ripgrep
+            install-deps: brew update && brew install ripgrep
+          - os: windows-latest
+            install-deps: choco install ripgrep
     steps:
       - uses: actions/checkout@v4
       - uses: rhysd/action-setup-vim@v1
@@ -32,9 +44,8 @@ jobs:
           version: ${{ matrix.rev }}
       - name: Prepare
         run: |
-          ${{ matrix.install-rg }}
+          ${{ matrix.install-deps }}
           rg --version
-
           git clone --depth 1 https://github.com/nvim-lua/plenary.nvim ../plenary.nvim
       - name: Run tests
         run: |

LICENSE

@@ -0,0 +1,25 @@
+
+MIT License
+
+
+Copyright (c) 2025 xentropic-dev 
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the “Software”), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+

README.md

@@ -1,3 +1,17 @@
+<div align="center">
+  <h1>🧭 Explorer.Dotnet.nvim</h1>
+  <p>
+    A Neovim plugin for C# development, providing a solution explorer and project
+    management tools.
+  </p>
+
+  <p>
+    <a href="https://opensource.org/licenses/MIT"><img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-e0af68.svg?style=for-the-badge&logo=opensourceinitiative&logoColor=white" /></a>
+    <a href="https://github.com/xentropic-dev/Explorer.Dotnet.nvim/actions"><img alt="CI" src="https://img.shields.io/github/actions/workflow/status/xentropic-dev/Explorer.Dotnet.nvim/ci.yml?style=for-the-badge&label=CI&logo=github&color=9ece6a" /></a>
+    <a href="https://github.com/xentropic-dev/Explorer.Dotnet.nvim/stargazers"><img alt="GitHub Stars" src="https://img.shields.io/github/stars/xentropic-dev/Explorer.Dotnet.nvim?style=for-the-badge&color=7aa2f7&logo=github" /></a>
+  </p>
+</div>
+
 # Neovim C# Development
 
 C# is a powerful language, and Neovim is a powerful editor. This project is
@@ -30,18 +44,18 @@ Here's the recommended way to setup this plugin with Lazy.
 
 ```lua
 return {
-  "xentropic-dev/nvim-dotnet-explorer",
-	config = function()
-		require("dotnet_explorer").setup({
-			renderer = {
-				width = 40,
-				side = "right",
-			},
-		})
-	end,
-	keys = {
-		{ "<leader>ee", "<cmd>ToggleSolutionExplorer<cr>", desc = "Toggle Solution Explorer" },
-	},
+  "xentropic-dev/explorer.dotnet.nvim",
+  config = function()
+    require("dotnet_explorer").setup({
+      renderer = {
+        width = 40,
+        side = "right",
+      },
+    })
+  end,
+  keys = {
+    { "<leader>ee", "<cmd>ToggleSolutionExplorer<cr>", desc = "Toggle Solution Explorer" },
+  },
 }
 
 ```
@@ -107,3 +121,4 @@ Tree view components:
   - [ ] create solution from template
   - [ ] create project from template
   - [ ] create file from template
+- [ ] support for new .NET slnx file format