README.md

alcatraz-packages

Package list repository for Alcatraz, the Xcode Package Manager.

To contribute your own package, fork this project and edit packages.json to include your submission in the correct section (plugins, color schemes, or templates), and submit a pull request.

Every package requires a name, url, and description, in a format determined by the package type (detailed below). The screenshot field is optional, but recommended for any package with a user interface component and should be a direct URL to a single image.

The JSON file is split up into 4 different parts: plugins, file_templates,color_schemes and project_templates. Make sure to add your package to the right category or it won't install.

After making your changes please run rspec from the console to check if everything is ok.

Plugin Format

The url should be a repository containing the Xcode project, and the name should be the same as the .xcodeproj file.

{
  "name": "LifeChangingPlugin",
  "url": "https://github.com/me/xcode-life-changing-plugin",
  "description": "Makes Xcode stop, collaborate and listen.",
  "screenshot": "http://raw.github.com/me/awesome-screenshot.png"
}

Color Scheme Format

Use link to raw color scheme file for url

{
  "name": "Most Amazing Theme Ever",
  "url": "https://raw.github.com/me/xcode-amazing-theme/master/ThemeFile.dvtcolortheme",
  "description": "Easy on the eyes, makes code sing",
  "screenshot": "http://raw.github.com/me/awesome-screenshot.png"
}

File or Project Template Format

The url should be a repository containing one or more templates

{
  "name": "Magical",
  "url": "https://raw.github.com/me/xcode-magic-templates",
  "description": "File templates for rainbow adventure coding"
}