docs: update readme

joedixon · Jan 3, 2019 · 2111404 · 2111404
1 parent 13db3aa
commit 2111404
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,33 @@
+<div align="center">
+
+![Nova Translation](logo.png)
+
+Translation management for your Nova application.
+
+![Nova Translation UI](translation.png)
+
+</div>
+
+------
+
+## About Nova Translation
+
+Nova Translation is a tool for Laravel Nova which allows you full control
+over your translations when using [Laravel's
+localization](https://laravel.com/docs/5.7/localization) functionality.
+
+The package allows you to manage your translations using either the native file
+based translations, but also provides a database driver which is useful in
+multi-server setups.
+
+It exposes a user interface allowing you to update existing and add new
+translations to your application.
+
+Below are a full list of features:
+
+- File and database drivers
+- Database translation loader (automatically load translations from the database
+  when Laravel's translation retrieval methods and the database driver)
+- User interface to add new languages and add and update translations
+- Artisan commands to manage your translations
+- Scan your application for missing translations
diff --git a/logo.png b/logo.png
diff --git a/translation.png b/translation.png