summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
-rw-r--r--doc/mrbgems/README.md5
1 files changed, 4 insertions, 1 deletions
diff --git a/doc/mrbgems/README.md b/doc/mrbgems/README.md
index 5897c5727..a87c7c92b 100644
--- a/doc/mrbgems/README.md
+++ b/doc/mrbgems/README.md
@@ -105,6 +105,7 @@ GEM directory. A typical GEM specification could look like this for example:
MRuby::Gem::Specification.new('c_and_ruby_extension_example') do |spec|
spec.license = 'MIT'
spec.author = 'mruby developers'
+ spec.summary = 'Example mrbgem using C and ruby'
end
```
@@ -119,7 +120,9 @@ information purpose:
* `spec.author` or `spec.authors` (Developer name or a list of them)
* `spec.version` (Current version)
* `spec.description` (Detailed description)
-* `spec.summary` (Short summary)
+* `spec.summary`
+ * One line short description of mrbgem.
+ * Printed in build summary of rake when set.
* `spec.homepage` (Homepage)
* `spec.requirements` (External requirements as information for user)