README.md in sigh-0.1.0 vs README.md in sigh-0.1.1
- old
+ new
@@ -10,19 +10,20 @@
<p align="center">
<img src="assets/sigh.png">
</p>
-Sigh - Create and maintain provisioning profiles
+Sigh
============
+#### Because you would rather spend your time building stuff than fighting provisioning
[](https://twitter.com/KrauseFx)
[](https://github.com/KrauseFx/sigh/blob/master/LICENSE)
[](http://rubygems.org/gems/sigh)
-Tired of manually creating and maintaining your provisioning profiles?
+Tired of manually creating, renewing and downloading your provisioning profiles?
```sigh``` handles all that for you. Just run ```sigh``` and it will do the rest.
Follow the developer on Twitter: [@KrauseFx](https://twitter.com/KrauseFx)
@@ -40,25 +41,40 @@
# Features
- **Download** the latest provisioning profile for your app
- **Renew** a provisioning profile, when it has expired
+- **Repair** a provisioning profile, when it is broken
- **Create** a new provisioning profile, if it doesn't exist already
-- Support for both **App Store**, **Ad Hoc** and **Development** profiles
+- Supports **App Store**, **Ad Hoc** and **Development** profiles
+- Support for **multiple Apple accounts**, storing your credentials securely in the Keychain
+- Support for **multiple Teams**
+### Why not let Xcode do the work?
-Check out this gif:
+- ```sigh``` can easily be integrated into your CI-server (e.g. Jenkins)
+- Xcode sometimes invalidates all existing profiles ([Proof](assets/SignErrors.png))
+- You have control over what happens
+- You still get to have the signing files, which you can then use for your build scripts or store in git
+See ```sigh``` in action:
+
# Installation
sudo gem install sigh
Make sure, you have the latest version of the Xcode command line tools installed:
xcode-select --install
+Install phantomjs (this is needed to control the Apple Developer Portal)
+
+ brew update && brew install phantomjs
+
+If you don't already have homebrew installed, [install it here](http://brew.sh/).
+
# Usage
sigh
Yes, that's the whole command!
@@ -70,11 +86,11 @@
If you want to generate an **Ad Hoc** profile instead of an App Store profile:
sigh --adhoc
-If you want to generate an **Development** profile:
+If you want to generate a **Development** profile:
sigh --development
By default, ```sigh``` will install the downloaded profile on your machine. If you just want to generate the profile and skip the installation, use the following flag:
@@ -84,10 +100,11 @@
## Environment Variables
In case you prefer environment variables:
- ```SIGH_USERNAME```
- ```SIGH_APP_IDENTIFIER```
+- ```SIGH_TEAM_ID``` (The exact name of your preferred team for this account)
# How does it work?
```sigh``` will access the ```iOS Dev Center``` to download, renew or generate the ```.mobileprovision``` file. Check out the full source code: [developer_center.rb](https://github.com/KrauseFx/sigh/blob/master/lib/sigh/developer_center.rb).
@@ -119,10 +136,10 @@
# License
This project is licensed under the terms of the MIT license. See the LICENSE file.
# Contributing
-1. Create an issue to discuss about your idea
+1. Create an issue to start a discussion about your idea
2. Fork it (https://github.com/KrauseFx/sigh/fork)
3. Create your feature branch (`git checkout -b my-new-feature`)
4. Commit your changes (`git commit -am 'Add some feature'`)
5. Push to the branch (`git push origin my-new-feature`)
6. Create a new Pull Request