Skip to content

Commit b22b0e1

Browse files
Mattia Roccobertonblocknotes
authored andcommitted
docs: improve README
1 parent b188603 commit b22b0e1

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

README.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,31 @@
44

55
A compact and composable dashboard component for Ruby.
66

7-
The main features are:
8-
- a Rack app that can be mounted in any Rack-enabled framework, it can even work standalone;
7+
Main features:
8+
- a Rack app that can be mounted in any Rack-enabled framework or used standalone;
99
- structured with plugins also for main components that can be replaced with little effort;
10-
- routing is provided by Roda, which is small and performant;
11-
- views are Phlex components, so plain Ruby objects for views and no assets are needed.
10+
- routing is provided by Roda which is small and performant;
11+
- views are Phlex components, so plain Ruby objects for views, no assets are needed.
1212

1313
Please ⭐ if you like it.
1414

1515
![screenshot](extra/screenshot.png)
1616

1717
## Install
1818

19-
- Add to your Gemfile: `gem 'tiny_admin', '~> 0.1'`
19+
- Add to your Gemfile: `gem 'tiny_admin', '~> 0.2'`
2020
- Mount the app in a route (check some examples with: Hanami, Rails, Roda and standalone in [extra](extra))
21-
- Configure the dashboard using `TinyAdmin.configure` and/or `TinyAdmin.configure_from_file` (see [configuration](#configuration) below)
21+
+ in Rails, update _config/routes.rb_: `mount TinyAdmin::Router => '/admin'`
22+
- Configure the dashboard using `TinyAdmin.configure` and/or `TinyAdmin.configure_from_file` (see [configuration](#configuration) below):
23+
24+
```rb
25+
TinyAdmin.configure do |settings|
26+
settings.root = {
27+
title: 'Home',
28+
page: Admin::PageRoot
29+
}
30+
end
31+
```
2232

2333
## Plugins and components
2434

0 commit comments

Comments
 (0)