diff --git a/packages/README.md b/packages/README.md index 4f671ad965e..f91b376be2a 100644 --- a/packages/README.md +++ b/packages/README.md @@ -6,6 +6,6 @@ The following directories are self contained packages: - hydefront: Hyde/HydeFront - realtime-compiler: Hyde/RealtimeCompiler - testing: Hyde/Testing -- ui-kit: UI Kit +- ui-kit: Hyde/UI-Kit The Hyde/Hyde package is the root directory of the monorepo, however, some persisted data is stored in here and is merged when splitting the monorepo. This means that the Hyde directory here is not a complete package, but rather a container for the persisted data. diff --git a/packages/ui-kit/LICENSE.md b/packages/ui-kit/LICENSE.md index 57367ae2dea..be6ab214367 100644 --- a/packages/ui-kit/LICENSE.md +++ b/packages/ui-kit/LICENSE.md @@ -1,6 +1,6 @@ MIT License -Copyright (c) Caen De Silva +Copyright (c) 2023 HydePHP Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/packages/ui-kit/README.md b/packages/ui-kit/README.md index acc94be2190..80cb77a4959 100644 --- a/packages/ui-kit/README.md +++ b/packages/ui-kit/README.md @@ -3,22 +3,12 @@ [![Latest Version on Packagist](https://img.shields.io/packagist/v/hyde/ui-kit.svg?style=flat-square)](https://packagist.org/packages/hyde/ui-kit) [![Total Downloads](https://img.shields.io/packagist/dt/hyde/ui-kit.svg?style=flat-square)](https://packagist.org/packages/hyde/ui-kit) - ## About The HydePHP UI Kit is a collection of minimalistic and un-opinionated TailwindCSS components for Laravel Blade, indented to be used with HydePHP. Note that these components may require CSS classes not present in the bundled app.css file and that you may need to recompile the CSS file using the included Laravel Mix configuration. - -## Warning - -The HydePHP UI Kit is still in development and is not yet ready for production use. -All components including their names can and probably will be changed. - -Versions in the 0.x range are considered unstable and may contain breaking changes. - - ## Installation You can install the package via composer: @@ -39,17 +29,14 @@ You might also need to recompile the CSS file using the Laravel Mix configuratio You can see a list of all available components in the [documentation](https://hydephp.github.io/ui-kit/). - ## Contributing -Please see the [hydephp/develop](https://github.com/hydephp/develop/issues) monorepo for details. +Contributions are welcome. Please see the [hydephp/develop](https://github.com/hydephp/develop/issues) monorepo for details. ### Security If you discover any security related issues, please email caen@desilva.se instead of using the issue tracker. -There are no backwards compatibility guarantees other than what is implicitly offered through the HydePHP packages requiring this package. - ## License diff --git a/packages/ui-kit/docs/documentation.md b/packages/ui-kit/docs/documentation.md index 7058d15162c..660d42333c1 100644 --- a/packages/ui-kit/docs/documentation.md +++ b/packages/ui-kit/docs/documentation.md @@ -4,13 +4,6 @@ The HydePHP UI Kit is a collection of minimalistic and un-opinionated TailwindCS indented to be used with HydePHP. Note that these components may require CSS classes not present in the bundled app.css file and that you may need to recompile the CSS file using the included Laravel Mix configuration. - -## Warning - -The HydePHP UI Kit is still in development and is not yet ready for production use. -All components including their names can and probably will be changed. - - ## Preface Please make sure you're familiar with [Laravel Blade](https://laravel.com/docs/blade) before using the HydePHP UI Kit.