Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
adrianthedev committed Oct 16, 2020
1 parent 0136777 commit 520ad5b
Showing 1 changed file with 27 additions and 8 deletions.
35 changes: 27 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,38 @@
![reviewdog](https://github.com/avo-hq/avo/workflows/reviewdog/badge.svg)
[![codecov](https://codecov.io/gh/avo-hq/avo/branch/master/graph/badge.svg?token=Q2LMFE4989)](https://codecov.io/gh/avo-hq/avo)

# Avo
![](https://avohq.io/img/logo-full-stroke-tiny-2x.png)

Configuration-based, no-maintenance, extendable Ruby on Rails admin

Avo is a beautiful next-generation framework that empowers you, the developer, to create fantastic admin panels for your Ruby on Rails apps with the flexibility to fit your needs as you grow.

[Get started](https://avohq.io/get-started)
## Get started

**Website**: [avohq.io](https://avohq.io)\
**Documentation**: [docs.avohq.io](https://docs.avohq.io)\
**Twitter**: [avo_hq](https://twitter.com/avo_hq)\
**Community**: [discord](https://discord.gg/pkTF6y8)

## Features

## Installation
- **Code driven configuration** - Configure your Rails dashboard entirely by writing Ruby code.
- **Resource Management** - Create a CRUD interface for Active Record from one command. No more copy-pasting view and controller files around.
- **Active Storage support** - Amazingly easy, **one-line**, single or multi-file integration with **ActiveStorage**.
- **Grid view** - Beautiful card layout to showcase your content.
- **Actions** - Run custom actions to one or more of your resources with as little as pressing a button 💪
- **Filters** - Write your own custom filters to quickly segment your data.
- **Keeps your app clean** - You don't need to change your app to use Avo. Drop it in your existing app or add it to a new one and you're done 🙌
- **Custom fields***- No worries if we missed a field you need. Generate a custom field in a jiffy.
- **Dashboard widgets and metrics*** - Customize your dashboard with the tools and analytics you need.
- **Custom tools*** - You need to add a page with something completely new, you've got it!
- **Authorization*** - Leverage Pundit policies to build a robust and scalable authorization system.
- **Themable*** - Dress it up into your own colors.
- **Localization*** - Have it available in any language you need.

*Some features are still under development

# Installation
Add this line to your application's `Gemfile`:

```ruby
Expand All @@ -20,8 +44,3 @@ And then execute:
```bash
$ bundle install
```

Website: [avohq.io](https://avohq.io)\
Docs: [docs.avohq.io](https://docs.avohq.io)\
Twitter: [avo_hq](https://twitter.com/avo_hq)\
Community: [discord](https://discord.gg/pkTF6y8)

0 comments on commit 520ad5b

Please sign in to comment.