diff --git a/Bolts.podspec b/Bolts.podspec new file mode 100644 index 000000000..6bd3d2769 --- /dev/null +++ b/Bolts.podspec @@ -0,0 +1,22 @@ +Pod::Spec.new do |s| + s.name = "Bolts" + s.version = "1.0.0" + s.summary = "Bolts is a collection of low-level libraries designed to make developing mobile apps easier." + s.description = <<-DESC + Bolts was designed by Parse and Facebook for our own internal use, and we have decided to open source these libraries to make them available to others. Using these libraries does not require using any Parse services. Nor do they require having a Parse or Facebook developer account. + + The first component in Bolts is "tasks", which make organization of complex asynchronous code more manageable. A task is kind of like a JavaScript Promise, but available for iOS and Android. + + For more information, see the [Bolts iOS API Reference](http://boltsframework.github.io/docs/ios/). + DESC + s.homepage = "https://github.com/BoltsFramework" + s.license = "BSD" + s.authors = { "Bryan Klimt" => "bklimt@fb.com", "David Poll" => "depoll@fb.com" } + s.source = { :git => "https://github.com/BoltsFramework/Bolts-iOS.git", :tag => s.version.to_s } + + s.requires_arc = true + + s.source_files = 'Bolts' + + s.public_header_files = 'Bolts/**/*.h' +end diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3f88db158..0867f10aa 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,11 +1,12 @@ -# Contributing to MyProject +# Contributing to Bolts We want to make contributing to this project as easy and transparent as possible. ## Pull Requests We actively welcome your pull requests. + 1. Fork the repo and create your branch from `master`. -2. If you've added code that should be tested, add tests +2. If you've added code that should be tested, add tests. 3. If you've changed APIs, update the documentation. 4. Ensure the test suite passes. 5. Make sure your code lints. diff --git a/Readme.md b/Readme.md index b23d56c8e..c1c3a449e 100644 --- a/Readme.md +++ b/Readme.md @@ -262,3 +262,10 @@ For common cases, such as dispatching on the main thread, we have provided defau }]; ``` +# Installation + +You can download the latest framework files from our [Releases page](https://github.com/BoltsFramework/Bolts-iOS/releases). + +Bolts is also available through [CocoaPods](http://cocoapods.org). To install it simply add the following line to your Podfile: + + pod "Bolts"