[Groonga-commit] groonga/groonga-log at a0812b9 [master] Write Description: section

Back to archive index

Kentaro Hayashi null+****@clear*****
Mon Sep 25 14:05:09 JST 2017


Kentaro Hayashi	2017-09-25 14:05:09 +0900 (Mon, 25 Sep 2017)

  New Revision: a0812b9975d91d6121c53e521ecf3d78eeae38c9
  https://github.com/groonga/groonga-log/commit/a0812b9975d91d6121c53e521ecf3d78eeae38c9

  Merged 6d071da: Merge pull request #2 from kenhys/add-description

  Message:
    Write Description: section

  Modified files:
    README.md
    groonga-log.gemspec

  Modified: README.md (+6 -1)
===================================================================
--- README.md    2017-09-25 13:46:56 +0900 (7ebb748)
+++ README.md    2017-09-25 14:05:09 +0900 (49ea065)
@@ -6,7 +6,12 @@ groonga-log
 
 ## Description
 
-TODO:
+Groonga-log is a collection of library and tools to
+process [Groonga](http://groonga.org/)'s log.
+
+Groonga's log is logged when `--log-path` option is specified. You can
+write a program to process Groonga log by using groonga-log as a
+library.
 
 ## Installation
 

  Modified: groonga-log.gemspec (+9 -0)
===================================================================
--- groonga-log.gemspec    2017-09-25 13:46:56 +0900 (0828d83)
+++ groonga-log.gemspec    2017-09-25 14:05:09 +0900 (fda6af1)
@@ -20,6 +20,10 @@ lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'groonga/log/version'
 
+clean_white_space = lambda do |entry|
+  entry.gsub(/(\A\n+|\n+\z)/, '') + "\n"
+end
+
 Gem::Specification.new do |spec|
   spec.name          = "groonga-log"
   spec.version       = Groonga::Log::VERSION
@@ -27,6 +31,11 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Horimoto Yasuhiro"]
   spec.email         = ["horimoto �� clear-code.com"]
 
+  readme = File.read("README.md", :encoding => "UTF-8")
+  entries = readme.split(/^\#\#\s(.*)$/)
+  description = clean_white_space.call(entries[entries.index("Description") + 1])
+  spec.summary, spec.description, = description.split(/\n\n+/, 3)
+
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-------------- next part --------------
HTML����������������������������...
URL: https://lists.osdn.me/mailman/archives/groonga-commit/attachments/20170925/12e9ff40/attachment-0001.htm 



More information about the Groonga-commit mailing list
Back to archive index