Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

documentation

  • Loading branch information...
commit c3009ff8cf738adbf48114072277b79fc024ec32 1 parent 9150c54
@amatsuda authored
View
0  LICENSE → MIT-LICENSE
File renamed without changes
View
29 README.md
@@ -1,29 +0,0 @@
-# Erd
-
-TODO: Write a gem description
-
-## Installation
-
-Add this line to your application's Gemfile:
-
- gem 'erd'
-
-And then execute:
-
- $ bundle
-
-Or install it yourself as:
-
- $ gem install erd
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
View
72 README.rdoc
@@ -0,0 +1,72 @@
+= Erd
+
+A Rails engine for drawing your app's ER diagram
+
+
+== Requirements
+
+* Rails 3.2 or 3.1
+
+* Graphviz
+
+
+== Installation
+
+Add 'erd' gem to your existing app's Gemfile:
+ gem 'erd'
+
+Bundle it:
+ % bundle
+
+
+== Usage
+
+Browse at your http://localhost:3000/erd
+
+
+== Features
+
+* Erd draws an ER diagram based on your app's database and models
+
+* You can drag and arrange the positions of each model
+
+* You can add column
+
+* You can rename column
+
+* You can alter column type
+
+* You can drop table
+
+* Finally, Erd generates migration files on the server (you need to run `rake db:migrate` by hand)
+
+
+== TODO
+
+* Better design
+
+* Better UI
+
+* Fix buggy JS
+
+* create table (we need to generate AR model file at the same time)
+
+* drop column (need to think of the UI)
+
+* performance (with large number of models)
+
+* stop depending on rails-erd and Graphviz
+
+* tests
+
+* cleaner code (the code is horrible. Please don't read the code, though of course your patches welcome)
+
+
+== Contributing to Erd
+
+* Send me your pull requests!
+
+
+== Copyright
+
+Copyright (c) 2012 Akira Matsuda. See MIT-LICENSE for further details.
View
14 erd.gemspec
@@ -2,17 +2,17 @@
require File.expand_path('../lib/erd/version', __FILE__)
Gem::Specification.new do |gem|
- gem.authors = ["Akira Matsuda"]
- gem.email = ["ronnie@dio.jp"]
- gem.description = %q{TODO: Write a gem description}
- gem.summary = %q{TODO: Write a gem summary}
- gem.homepage = ""
+ gem.authors = ['Akira Matsuda']
+ gem.email = ['ronnie@dio.jp']
+ gem.description = 'erd engine on Rails'
+ gem.summary = 'erd engine on Rails'
+ gem.homepage = ''
gem.files = `git ls-files`.split($\)
gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
- gem.name = "erd"
- gem.require_paths = ["lib"]
+ gem.name = 'erd'
+ gem.require_paths = ['lib']
gem.version = Erd::VERSION
gem.add_runtime_dependency 'rails-erd', ['>= 0.4.5']
Please sign in to comment.
Something went wrong with that request. Please try again.