Permalink
Browse files

Improve docs

  • Loading branch information...
1 parent 2e72ee8 commit 7a6aea0bd040c5227ec6c2adf4fd20f0537bf537 mguymon committed Sep 3, 2012
View
@@ -9,5 +9,6 @@ group :development do
gem "bundler", "~> 1.1.4"
gem "jeweler", "~> 1.8.4"
gem 'jruby-openssl'
+ gem 'yard
end
View
@@ -47,4 +47,23 @@ Solr home. An example _solr_sail.conf_:
To change the directory of the Solr home, you can pass _--solr_home_ or _-h_:
solrsail start -h new/path/to/solr
+
+### From Ruby
+
+#### Setup Solr
+
+To create a config directory
+
+ require 'rubygems'
+ require 'solr_sail'
+
+ SolrSail.install_config()
+
+#### Start up Solr
+
+ require 'rubygems'
+ require 'solr_sail'
+
+ SolrSail.start()
+
@@ -1,5 +1,23 @@
package com.tobedevoured.solrsail;
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
import java.io.File;
import java.io.IOException;
@@ -1,5 +1,23 @@
package com.tobedevoured.solrsail;
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
import java.io.File;
import java.io.FileOutputStream;
import java.io.FileWriter;
@@ -1,5 +1,23 @@
package com.tobedevoured.solrsail;
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
import java.io.File;
import java.util.jar.JarEntry;
import java.util.jar.JarFile;
View
@@ -4,12 +4,22 @@
require 'solr_sail/version'
+# :title:SolrSail
+#
+# Handles extracting the config and running an instance of Solr
+#
+# = Authors
+# Michael Guymon
+#
module SolrSail
DEFAULT_JAR_NAME = "solr_sail-#{SolrSail::VERSION}.jar"
DEFAULT_JAR = File.expand_path("#{File.dirname(__FILE__)}/../#{DEFAULT_JAR_NAME}")
DEFAULT_LOCKFILE = File.expand_path("#{File.dirname(__FILE__)}/../Jarfile.lock")
+ #
+ # Extract the configuration files for Solr
+ #
# opts:
# * :jar: path to the solr_sail jar, default to jar packaged with the gem
# * :lockfile: path to lockfile that contains the jar dependencies, defaults to Jarfile.lock packaged with the gem
@@ -31,6 +41,8 @@ def self.install_config( opts )
end
#
+ # Start Solr
+ #
# The server is configued by solr_sail.conf loaded from the solr home. The
# opts passed in override solr_sail.conf
#

0 comments on commit 7a6aea0

Please sign in to comment.