README.md in claide-plugins-0.9.1 vs README.md in claide-plugins-0.9.2
- old
+ new
@@ -1,44 +1,73 @@
-# Cocoapods plugins
+# CLAide plugins
[](https://travis-ci.org/CocoaPods/cocoapods-plugins)
[](https://codeclimate.com/github/CocoaPods/cocoapods-plugins)
[](https://codeclimate.com/github/CocoaPods/cocoapods-plugins)
-CocoaPods plugin which shows info about available CocoaPods plugins or helps you get started developing a new plugin. Yeah, it's very meta.
+CLAide plugin which shows info about available CLAide plugins or helps you get started developing a new plugin. Yeah, it's very meta.
+It provides the foundations for CocoaPods and Danger's plugin infrastructure.
+
## Installation
- $ gem install cocoapods-plugins
+This isn't really a user-facing gem, you need to add it to your library.
+Here is how it is added into Danger:
+
+```ruby
+module Danger
+ class Runner < CLAide::Command
+ require "danger/commands/init"
+ require "danger/commands/local"
+ require "danger/commands/systems"
+
+ # manually add claide plugins as subcommands
+ require "claide_plugin"
+ @subcommands << CLAide::Command::Plugins
+ CLAide::Plugins.config =
+ CLAide::Plugins::Configuration.new(
+ "Danger",
+ "danger",
+ "https://raw.githubusercontent.com/danger/danger.systems/master/plugins-search-generated.json",
+ "https://github.com/danger/danger-plugin-template"
+ )
+
+ require "danger/commands/plugins/plugin_lint"
+ require "danger/commands/plugins/plugin_json"
+ require "danger/commands/plugins/plugin_readme"
+
+```
+
## Usage
##### List installed plugins
- $ pod plugins installed
+ $ [your tool] plugins installed
-List all installed CocoaPods plugins with their respective version (and pre_install/post_insall hooks if any)
+List all installed plugins with their respective version
##### List known plugins
- $ pod plugins list
+ $ [your tool] plugins list
-List all known CocoaPods plugins (according to the list hosted on `http://github.com/CocoaPods/cocoapods-plugins`)
+List all known plugins (according to the list hosted on `http://github.com/CocoaPods/cocoapods-plugins`)
##### Search plugins
- $ pod plugins search QUERY
+ $ [your tool] plugins search QUERY
Search plugins whose name contains the given text (ignoring case). With --full, it searches by name but also by author and description.
##### Create a new plugin
- $ pod plugins create NAME [TEMPLATE_URL]
+ $ [your tool] plugins create NAME [TEMPLATE_URL]
-Create a scaffold for the development of a new plugin according to the CocoaPods best practices.
+Create a scaffold for the development of a new plugin according to the your tool's best practices.
+
If a `TEMPLATE_URL`, pointing to a git repo containing a compatible template, is specified, it will be used in place of the default one.
## Get your plugin listed
- $ pod plugins publish
+ $ [your tool] plugins publish
-Create an issue in the `cocoapods-plugins` GitHub repository to ask for your plugin to be added to the official list (with the proper JSON fragment to be added to `plugins.json` so we just have to copy/paste it).
+Create an issue in the plugins search GitHub repository to ask for your plugin to be added to the official list (with the proper JSON fragment to be added to `plugins.json` so we just have to copy/paste it).