Pub dev setup (#6)

* Extended readme

* Filled CHANGELOG

* Improved example

* Update README.md

.flutter-plugins-dependencies

@@ -1 +1 @@
-{"info":"This is a generated file; do not edit or check into version control.","plugins":{"ios":[{"name":"highlights_plugin","path":"/Users/tkadziolka/.pub-cache/hosted/pub.dev/highlights_plugin-0.2.0/","native_build":true,"dependencies":[]}],"android":[{"name":"highlights_plugin","path":"/Users/tkadziolka/.pub-cache/hosted/pub.dev/highlights_plugin-0.2.0/","native_build":true,"dependencies":[]}],"macos":[],"linux":[],"windows":[],"web":[]},"dependencyGraph":[{"name":"highlights_plugin","dependencies":[]}],"date_created":"2024-11-18 20:15:47.325704","version":"3.24.0","swift_package_manager_enabled":false}
+{"info":"This is a generated file; do not edit or check into version control.","plugins":{"ios":[{"name":"highlights_plugin","path":"/Users/tkadziolka/.pub-cache/hosted/pub.dev/highlights_plugin-0.2.0/","native_build":true,"dependencies":[]}],"android":[{"name":"highlights_plugin","path":"/Users/tkadziolka/.pub-cache/hosted/pub.dev/highlights_plugin-0.2.0/","native_build":true,"dependencies":[]}],"macos":[],"linux":[],"windows":[],"web":[]},"dependencyGraph":[{"name":"highlights_plugin","dependencies":[]}],"date_created":"2024-11-18 21:40:21.617016","version":"3.24.0","swift_package_manager_enabled":false}

CHANGELOG.md

@@ -1,3 +1,14 @@
+## 0.1.0
+
+### Added
+
+- highlights_plugin 0.2.0
+- extensions unit tests
+- CodeEditText
+- CodeTextView
+
 ## 0.0.1
 
-* TODO: Describe initial release.
+### Added
+
+- initial setup

README.md

@@ -2,6 +2,85 @@
 
 Flutter syntax highlighting widgets based on [Highlights](https://github.com/SnipMeDev/Highlights) library. 
 
+<img width="1358" alt="iShot_2024-11-18_21 55 36" src="https://github.com/user-attachments/assets/066a248b-facc-40d1-b518-03ff92c8c847">
+
+## Installation
+
+```dart
+flutter pub add kode_view
+```
+
+## Usage
+
+### CodeTextView
+
+```dart
+import 'package:flutter/material.dart';
+import 'package:kode_view/kode_view.dart';
+
+@override
+Widget build(BuildContext context) {
+  final codeSnippet = "class HelloWorld {}";
+  
+  return MaterialApp(
+    home: Scaffold(
+      appBar: ...,
+      body: CodeTextView(
+        code: codeSnippet,
+        language: "Java",
+        theme: "darcula",
+        options: ...,
+      ),
+    ),
+  );
+}
+```
+
+### CodeEditText
+
+```dart
+import 'package:flutter/material.dart';
+import 'package:kode_view/kode_view.dart';
+
+class _MyAppState extends State<MyApp> {
+  final SyntaxHighlightingController controller =
+  SyntaxHighlightingController(text: codeSnippet);
+
+  @override
+  Widget build(BuildContext context) {
+    final codeSnippet = "class HelloWorld {}";
+
+    return MaterialApp(
+      home: Scaffold(
+        appBar: ...,
+        body: CodeEditText(
+          code: codeSnippet,
+          controller: controller,
+          showCursor: true,
+        ),
+      ),
+    );
+  }
+}
+
+```
+
+## Features
+- 17 supported languages (Kotlin, Dart, Swift, PHP, etc)
+- Light / dark mode
+- 6 built-in themes
+- Phrase bolding (emphasis)
+- Result caching and support for incremental changes
+
+## Support
+
+- Android ✅
+- iOS ✅
+- macOS 🔴 (Not yet)
+- Linux 🔴 (Not yet)
+- Windows 🔴 (Not yet)
+- Web 🔴 (Not yet)
+
 License 🖋️
 =======
 

example/lib/main.dart

@@ -18,6 +18,7 @@ class MyApp extends StatefulWidget {
 class _MyAppState extends State<MyApp> {
   final SyntaxHighlightingController controller =
       SyntaxHighlightingController(text: codeSnippet);
+
   @override
   Widget build(BuildContext context) {
     return MaterialApp(
@@ -26,32 +27,40 @@ class _MyAppState extends State<MyApp> {
           title: const Text('Kode View example'),
         ),
         body: Center(
-            child: Column(
-          children: [
-            const Text("CodeTextView"),
-            const SizedBox(
-              height: 12,
-            ),
-            CodeTextView(
-              code: codeSnippet,
-              language: "Java",
-              theme: "darcula",
-              options: TextSelectionOptions(
-                copy: true,
-                selectAll: true,
-                share: true,
+          child: Column(
+            crossAxisAlignment: CrossAxisAlignment.center,
+            children: [
+              const Text("CodeTextView"),
+              const SizedBox(
+                height: 12,
+              ),
+              Padding(
+                padding: const EdgeInsets.all(16.0),
+                child: CodeTextView(
+                  code: codeSnippet,
+                  language: "Java",
+                  theme: "darcula",
+                  options: TextSelectionOptions(
+                    copy: true,
+                    selectAll: true,
+                    share: true,
+                  ),
+                ),
               ),
-            ),
-            const SizedBox(height: 24),
-            const Text("CodeEditText"),
-            const SizedBox(height: 12),
-            CodeEditText(
-              code: codeSnippet,
-              controller: controller,
-              showCursor: true,
-            ),
-          ],
-        )),
+              const SizedBox(height: 24),
+              const Text("CodeEditText"),
+              const SizedBox(height: 12),
+              Padding(
+                padding: const EdgeInsets.all(16.0),
+                child: CodeEditText(
+                  code: codeSnippet,
+                  controller: controller,
+                  showCursor: true,
+                ),
+              ),
+            ],
+          ),
+        ),
       ),
     );
   }

example/pubspec.lock

@@ -110,7 +110,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "0.0.1"
+    version: "0.1.0"
   leak_tracker:
     dependency: transitive
     description:

lib/src/presentation/styles/text_styles.dart

@@ -17,7 +17,7 @@ class TextStyles extends Text {
           key: key,
           style: const TextStyle(
             fontSize: 16,
-            fontStyle: FontStyle.italic,
+            fontStyle: FontStyle.normal,
           ),
         );
 

pubspec.yaml

@@ -1,6 +1,6 @@
 name: kode_view
 description: Flutter syntax highlighting widgets based on Highlights
-version: 0.0.1
+version: 0.1.0
 homepage: https://github.com/SnipMeDev/kode_view
 
 environment: