napkin

napkin is a reimagining of Uber's RIBs with RXSwift replaced by Combine and the Leak Detector removed (you should use Xcode Instruments instead).

Installation

napkin can be installed with Swift Package Manager.

Swift Package Manager (Xcode 12 or higher)

The preferred way of installing napkin is via the Swift Package Manager.

1. In Xcode, open your project and navigate to File → Swift Packages → Add Package Dependency...
2. Paste the repository URL (https://github.com/WikipediaBrown/napkin.git) and click Next.
3. For Rules, select Version (Up to Next Major) and click Next.
4. Click Finish.

Adding Package Dependencies to Your App

Usage

Coming Soon!

Tooling

Get napkin Xcode templates

napkin comes with sweet templates that let you add all of the components of a napkin (Builder, Interactor, Router & optional ViewController) straight from the New > File.. menu. To add them:

Clone the repository

git clone https://github.com/WikipediaBrown/napkin.git

Install Xcode Templates

bash napkin/Tools/InstallXcodeTemplates.sh

Check Xcode

Open an Xcode project and create a new napkin. Let us know if it doesn't work by creating an issue

Versioning

napkin releases a new version on GitHub automatically when a pull request is approved from the develop branch to the main branch.

Contribute

Send a pull request my dude.

Author

Wikipedia Brown

License

napkin is available under the Apache 2.0 license. See the LICENSE file for more info.

Made with 🌲🌲🌲 in Cascadia