Release prep

Author: luke-parallax

CHANGELOG.md

@@ -2,6 +2,6 @@
 
 All notable changes to `filament-syntax-entry` will be documented in this file.
 
-## 1.0.0 - 202X-XX-XX
+## 1.0.0 - Feb 2, 2024
 
-- initial release
+- Initial release

README.md

@@ -1,77 +1,174 @@
-# Add a Filament infolist entry for syntax highlighting.
+# Filament Comments
 
-[![Latest Version on Packagist](https://img.shields.io/packagist/v/parallax/filament-syntax-entry.svg?style=flat-square)](https://packagist.org/packages/parallax/filament-syntax-entry)
-[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/parallax/filament-syntax-entry/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/parallax/filament-syntax-entry/actions?query=workflow%3Arun-tests+branch%3Amain)
-[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/parallax/filament-syntax-entry/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/parallax/filament-syntax-entry/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
-[![Total Downloads](https://img.shields.io/packagist/dt/parallax/filament-syntax-entry.svg?style=flat-square)](https://packagist.org/packages/parallax/filament-syntax-entry)
+[![Latest Version on Packagist](https://img.shields.io/packagist/v/parallax/filament-syntax-entry?style=flat-square)](https://packagist.org/packages/parallax/filament-syntax-entry)
+[![Software License](https://img.shields.io/packagist/l/parallax/filament-syntax-entry?style=flat-square)](LICENSE.md)
+[![Total Downloads](https://img.shields.io/packagist/dt/parallax/filament-syntax-entry?style=flat-square)](https://packagist.org/packages/parallax/filament-syntax-entry)
+![Stars](https://img.shields.io/github/stars/parallax/filament-syntax-entry?style=flat-square)
 
+Add a Filament infolist entry for themeable syntax highlighting using [highlight.js](https://highlightjs.org).
 
-
-This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
+<img class="filament-hidden" src="https://github.com/parallax/filament-syntax-entry/raw/main/assets/filament-syntax-entry.jpg"/>
 
 ## Installation
 
-You can install the package via composer:
+Install the package via composer:
 
 ```bash
 composer require parallax/filament-syntax-entry
 ```
 
-You can publish and run the migrations with:
-
-```bash
-php artisan vendor:publish --tag="filament-syntax-entry-migrations"
-php artisan migrate
-```
-
-You can publish the config file with:
-
-```bash
-php artisan vendor:publish --tag="filament-syntax-entry-config"
-```
-
 Optionally, you can publish the views using
 
 ```bash
 php artisan vendor:publish --tag="filament-syntax-entry-views"
 ```
 
-This is the contents of the published config file:
+## Quickstart
+
+### Add the Infolist entry
+
+Add the `SyntaxEntry` to the `$infolist->schema()` method.
 
 ```php
-return [
-];
+<?php
+
+namespace App\Filament\Resources;
+
+use Parallax\FilamentSyntaxEntry\SyntaxEntry;
+
+class ProductResource extends Resource
+{
+    public static function infolist(Infolist $infolist): Infolist
+    {
+        return $infolist
+            ->schema([
+                SyntaxEntry::make('metadata'),
+            ]);
+    }
+}
 ```
 
-## Usage
+### Setting the language
+
+Automatic language detection is enabled by default so this isn't required, but if you would like to define the language used you may use the `language()` method:
 
 ```php
-$filamentSyntaxEntry = new Parallax\FilamentSyntaxEntry();
-echo $filamentSyntaxEntry->echoPhrase('Hello, Parallax!');
+SyntaxEntry::make('metadata')
+    ->language('json');
 ```
 
-## Testing
+To keep the budle size down only the following languages are currently available:
 
-```bash
-composer test
-```
+- `bash`
+- `css`
+- `dockerfile`
+- `graphql`
+- `javascript`
+- `json`
+- `markdown`
+- `php`
+- `scss`
+- `shell`
+- `sql`
+- `typescript`
+- `xml`
+- `yaml`
 
-## Changelog
+### Setting the theme
 
-Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
+You may override the default themes using the `theme()` and/or `darkModeTheme()` methods:
 
-## Contributing
+```php
+SyntaxEntry::make('metadata')
+    ->theme('filament')
+    ->darkModeTheme('filament-dark');
+```
 
-Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
+To keep the budle size down only the following languages are currently available:
+
+- `a11y-dark`
+- `a11y-light`
+- `agate`
+- `an-old-hope`
+- `androidstudio`
+- `arduino-light`
+- `arta`
+- `ascetic`
+- `atom-one-dark-reasonable`
+- `atom-one-dark`
+- `atom-one-light`
+- `brown-paper`
+- `codepen-embed`
+- `color-brewer`
+- `dark`
+- `default`
+- `devibeans`
+- `docco`
+- `far`
+- `felipec`
+- `filament-dark` (default dark mode theme)
+- `filament` (default theme)
+- `foundation`
+- `github-dark-dimmed`
+- `github-dark`
+- `github`
+- `gml`
+- `googlecode`
+- `gradient-dark`
+- `gradient-light`
+- `grayscale`
+- `hybrid`
+- `idea`
+- `intellij-light`
+- `ir-black`
+- `isbl-editor-dark`
+- `isbl-editor-light`
+- `kimbie-dark`
+- `kimbie-light`
+- `lightfair`
+- `lioshi`
+- `magula`
+- `mono-blue`
+- `monokai-sublime`
+- `monokai`
+- `night-owl`
+- `nnfx-dark`
+- `nnfx-light`
+- `nord`
+- `obsidian`
+- `panda-syntax-dark`
+- `panda-syntax-light`
+- `paraiso-dark`
+- `paraiso-light`
+- `pojoaque`
+- `purebasic`
+- `qtcreator-dark`
+- `qtcreator-light`
+- `rainbow`
+- `routeros`
+- `school-book`
+- `shades-of-purple`
+- `srcery`
+- `stackoverflow-dark`
+- `stackoverflow-light`
+- `sunburst`
+- `tokyo-night-dark`
+- `tokyo-night-light`
+- `tomorrow-night-blue`
+- `tomorrow-night-bright`
+- `vs`
+- `vs2015`
+- `xcode`
+- `xt256`
 
-## Security Vulnerabilities
+## Changelog
 
-Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
+Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
 
 ## Credits
 
-- [Parallax](https://github.com/parallax)
-- [All Contributors](../../contributors)
+- [Parallax](https://parall.ax)
+- [Contributors](https://github.com/parallax/filament-syntax-entry/graphs/contributors)
 
 ## License
 

assets/filament-syntax-entry.jpg

@@ -1,6 +1,6 @@
 {
     "name": "parallax/filament-syntax-entry",
-    "description": "Add a Filament infolist entry for syntax highlighting.",
+    "description": "Add a Filament infolist entry for themeable syntax highlighting.",
     "keywords": [
         "parallax",
         "laravel",
@@ -69,4 +69,4 @@
     },
     "minimum-stability": "dev",
     "prefer-stable": true
-}
+}