readme.md in lesli_admin-0.1.0 vs readme.md in lesli_admin-0.2.0

- old
+ new

@@ -1,28 +1,71 @@ -# LesliAdmin -Short description and motivation. +<p align="center"> + <img width="90" alt="LesliCloud logo" src="./app/assets/images/lesli_admin/admin-logo.svg" /> + <h3 align="center">Administration area for the Lesli Framework.</h3> +</p> -## Usage -How to use my plugin. +<hr/> + <p align="center"> + <a target="blank" href="https://rubygems.org/gems/lesli_admin"> + <img src="https://badge.fury.io/rb/lesli_admin.svg" alt="Gem Version" height="18"> + </a> + </p> +<hr/> -## Installation -Add this line to your application's Gemfile: +### Quick start -```ruby -gem "lesli_admin" +```shell +# Add LesliAdmin engine +bundle add lesli_admin ``` -And then execute: -```bash -$ bundle +```shell +# Setup database +rake lesli:db:setup ``` -Or install it yourself as: -```bash -$ gem install lesli_admin +```ruby +# Load LesliAdmin +Rails.application.routes.draw do + mount LesliAdmin::Engine => "/admin" +end ``` -## Contributing -Contribution directions go here. -## License -The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). +### Documentation +* [Roadmap](./docs/roadmap.md) +* [database](./docs/database.md) +* [documentation](https://www.lesli.dev/documentation/) + + +### Get in touch + +* [Website: https://www.lesli.tech](https://www.lesli.tech) +* [Email: hello@lesli.tech](hello@lesli.tech) +* [Twitter: @LesliTech](https://twitter.com/LesliTech) + + +### License +------- +Copyright (c) 2023, Lesli Technologies, S. A. + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see http://www.gnu.org/licenses/. + +<hr /> +<br /> + +<p align="center"> + <img width="200" alt="Lesli logo" src="https://cdn.lesli.tech/lesli/brand/app-logo.svg" /> + <h4 align="center">Ruby on Rails SaaS Development Framework.</h4> +</p> +