README.md in localtower-2.0.0 vs README.md in localtower-2.0.1
- old
+ new
@@ -4,11 +4,11 @@
<img src="https://raw.githubusercontent.com/damln/localtower/0f279b82e9a7701b9f0aab21a8e4561468535046/public/com/twitter-cover-2.png" alt="Localtower">
</p>
## Introduction
-
+
**- What is Localtower?**
Localtower is a Rails Engine mountable in development environment to help you generate migrations for your Rails application.
It's like ActiveAdmin or Sidekiq UI.
@@ -37,19 +37,19 @@
## Screenshots
### Create a model
-
+
### Create a migration
-
+
### See the Migrations (and migrate)
-
+
## Installation
Please use the best localtower version: `>= 2.0.0`
See installation process below.
@@ -60,18 +60,13 @@
- Ruby >= 2.3
Add to your `Gemfile` file:
```ruby
-# In your current group 'development':
group :development do
- # [probably other gems here]
- gem 'localtower'
+ gem 'localtower', '~> 2.0'
end
-
-# Or as a one liner:
-gem 'localtower', group: :development
```
Run command in your terminal:
```bash
@@ -111,39 +106,56 @@
## Usage
To access the UI, run your local rails server and open your browser at [http://localhost:3000/localtower](http://localhost:3000/localtower).
-## Full scenrio ScreenShots
+## Full scenario
### Create a model
-
+
It will create a migration file:
-
+
### Create a migration
-
+
It will generate a migration file:
-
+
### Create another model
Now, we add a `Book` model:
-
+
### All the migrations generated
-
+
+### Files generated
+Every action made from the UI will generate native Rails migration files.
+Exactly like the `rails generate` command.
+But instead of generating files in the console, they are generated in the `db/migrate` folder.
+
+- The models:
+
+
+
+- The migration files:
+
+
+
+- The final schema:
+
+
+
## Upgrading
I recommend you to upgrade to the latest version which is `2.0.0`.
To upgrade, just use the latest version of Localtower.
You have nothing else to do.
@@ -187,10 +199,10 @@
## Deploy latest gem version
Only for official contributors.
- git tag v2.0.0 # change by last version
+ git tag vX.X.X # change by last version
git push --tags
rm *.gem
gem build localtower.gemspec
gem push localtower-*.gem