| 1 |
|
| 2 | <h1 align="center">
|
| 3 | 👋 Welcome to <br><code>pod-install</code>
|
| 4 | </h1>
|
| 5 |
|
| 6 | <p align="center">A fast, zero-dependency package for cutting down on common issues developers have when running <code>pod install</code>.</p>
|
| 7 |
|
| 8 | <p align="center">
|
| 9 | <img src="https://flat.badgen.net/packagephobia/install/pod-install">
|
| 10 |
|
| 11 | <a href="https://www.npmjs.com/package/pod-install">
|
| 12 | <img alt="Install pod-install instantly" src="https://flat.badgen.net/npm/dw/pod-install" target="_blank" />
|
| 13 | </a>
|
| 14 | </p>
|
| 15 |
|
| 16 |
|
| 17 |
|
| 18 | ## 🚀 Usage
|
| 19 |
|
| 20 | ```sh
|
| 21 | npx pod-install
|
| 22 | ```
|
| 23 |
|
| 24 | 👋 **Notice:** This package is not limited to native React projects, you can use it with any iOS or Xcode project using CocoaPods (like Ionic, or Flutter).
|
| 25 |
|
| 26 | ## 🤔 Why?
|
| 27 |
|
| 28 | All native packages (especially those installed with NPM) often need to explain the following:
|
| 29 |
|
| 30 | - What is CocoaPods.
|
| 31 | - What is gem.
|
| 32 | - How to install CocoaPods.
|
| 33 | - `cd` into the proper directory before running `pod install`.
|
| 34 | - You may need run `pod repo update` to fix your project.
|
| 35 | - Why CocoaPods requires a darwin machine.
|
| 36 |
|
| 37 | But now you can simply instruct users to run `npx pod-install`.
|
| 38 |
|
| 39 | This package will do the following:
|
| 40 |
|
| 41 | - Check if the machine is darwin.
|
| 42 | - If not then it'll quit with a helpful error message.
|
| 43 | - Ensure CocoaPods CLI is installed on the machine.
|
| 44 | - If not then it'll try to install CocoaPods CLI, first with gem, then with homebrew.
|
| 45 | - Check if there is an Xcode project in the current directory
|
| 46 | - If not then it'll try again in an `ios/` directory (if one exists).
|
| 47 | - Run `pod install`
|
| 48 | - If `pod install` fails because the repo is out of date, then it'll run `pod repo update` and try again.
|
| 49 |
|
| 50 | ## ⚙️ Options
|
| 51 |
|
| 52 | For more information run `npx pod-install --help` (or `-h`)
|
| 53 |
|
| 54 | | Flag | Input | Description | Default |
|
| 55 | | ------------------- | ----------- | --------------------------------------------- | ---------------------- |
|
| 56 | | `--non-interactive` | `[boolean]` | Skip prompting to install CocoaPods with sudo | `process.stdout.isTTY` |
|
| 57 | | `--quiet` | `[boolean]` | Only print errors | `false` |
|
| 58 |
|
| 59 | ## License
|
| 60 |
|
| 61 | The Expo source code is made available under the [MIT license](LICENSE). Some of the dependencies are licensed differently, with the BSD license, for example.
|