Merge pull request #94 from lukepistrol/documentation/improvements

[documentation]: add images, link to `CodeEditLanguages`

Package.resolved

@@ -5,8 +5,8 @@
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/CodeEditApp/CodeEditLanguages.git",
       "state" : {
-        "revision" : "271feca0ea37002441c73e7f16ee5600b6fc00b2",
-        "version" : "0.1.2"
+        "revision" : "6b412f6eb6f5d7bdfa91f2d92105b4d6dae12df3",
+        "version" : "0.1.3"
       }
     },
     {

Package.swift

@@ -19,7 +19,7 @@ let package = Package(
         ),
         .package(
             url: "https://github.com/CodeEditApp/CodeEditLanguages.git",
-            exact: "0.1.2"
+            exact: "0.1.3"
         ),
     ],
     targets: [

README.md

@@ -10,6 +10,9 @@
   <a aria-label="Join the community on Discord" href="https://discord.gg/vChUXVf9Em" target="_blank">
     <img alt="" src="https://img.shields.io/badge/Join%20the%20community-black.svg?style=for-the-badge&logo=Discord">
   </a>
+  <a aria-label="Read the Documentation" href="https://codeeditapp.github.io/CodeEditTextView/documentation/codeedittextview/" target="_blank">
+    <img alt="" src="https://img.shields.io/badge/Documentation-black.svg?style=for-the-badge&logo=readthedocs&logoColor=blue">
+  </a>
 </p>
 
 An Xcode-inspired code editor view written in Swift powered by tree-sitter for [CodeEdit](https://github.com/CodeEditApp/CodeEdit). Features include syntax highlighting (based on the provided theme), code completion, find and replace, text diff, validation, current line highlighting, minimap, inline messages (warnings and errors), bracket matching, and more.

Sources/CodeEditTextView/Documentation.docc/Documentation.md

@@ -4,8 +4,20 @@ A code editor with syntax highlighting powered by tree-sitter.
 
 ## Overview
 
+![logo](codeedittextview-logo)
+
+An Xcode-inspired code editor view written in Swift powered by tree-sitter for [CodeEdit](https://github.com/CodeEditApp/CodeEdit). Features include syntax highlighting (based on the provided theme), code completion, find and replace, text diff, validation, current line highlighting, minimap, inline messages (warnings and errors), bracket matching, and more.
+
 This package includes both `AppKit` and `SwiftUI` components. It also relies on the `CodeEditLanguages` and `Theme` module. 
 
+![banner](preview)
+
+## Syntax Highlighting
+
+``CodeEditTextView`` uses `tree-sitter` for syntax highlighting. A list of already supported languages can be found [here](https://github.com/CodeEditApp/CodeEditTextView/issues/15).
+
+New languages need to be added to the [CodeEditLanguages](https://github.com/CodeEditApp/CodeEditLanguages) repo.
+
 ## Dependencies
 
 Special thanks to both [Marcin Krzyzanowski](https://twitter.com/krzyzanowskim) & [Matt Massicotte](https://twitter.com/mattie) for the great work they've done!
@@ -25,4 +37,3 @@ Special thanks to both [Marcin Krzyzanowski](https://twitter.com/krzyzanowskim)
 ### Theme
 
 - ``EditorTheme``
-