├── .gitignore ├── .travis.yml ├── Gemfile ├── LICENSE ├── README.md ├── Rakefile ├── assets └── xcode-screenshot.png ├── bin └── xcode-readme ├── correct.yml └── xcode-readme.gemspec /.gitignore: -------------------------------------------------------------------------------- 1 | *.gem 2 | *.rbc 3 | /.config 4 | /coverage/ 5 | /InstalledFiles 6 | /pkg/ 7 | /spec/reports/ 8 | /spec/examples.txt 9 | /test/tmp/ 10 | /test/version_tmp/ 11 | /tmp/ 12 | 13 | ## Specific to RubyMotion: 14 | .dat* 15 | .repl_history 16 | build/ 17 | 18 | ## Documentation cache and generated files: 19 | /.yardoc/ 20 | /_yardoc/ 21 | /doc/ 22 | /rdoc/ 23 | 24 | ## Environment normalization: 25 | /.bundle/ 26 | /vendor/bundle 27 | /lib/bundler/man/ 28 | 29 | # for a library or gem, you might want to ignore these files since the code is 30 | # intended to run in multiple environments; otherwise, check them in: 31 | # Gemfile.lock 32 | # .ruby-version 33 | # .ruby-gemset 34 | 35 | # unless supporting rvm < 1.11.0 or doing something fancy, ignore this: 36 | .rvmrc 37 | 38 | temp-* 39 | 40 | .DS_Store 41 | 42 | Gemfile.lock 43 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: ruby 2 | rvm: 2.4.1 3 | install: bundle install 4 | script: bundle exec xcode-readme 5 | -------------------------------------------------------------------------------- /Gemfile: -------------------------------------------------------------------------------- 1 | source 'https://rubygems.org' 2 | 3 | gemspec 4 | gem 'readme-correct', :git => 'https://github.com/dkhamsing/readme-correct.git', :branch => 'stable' 5 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2016 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # xcode-readme 2 | 3 | Are you sad when you see [Xcode](https://developer.apple.com/xcode/) spelled xCode in a README? :sob: 4 | 5 | Don't be sad, just `xcode-readme` it! :smile: 6 | 7 | ``` 8 | $ bundle exec xcode-readme https://github.com/rnpm/rnpm 9 | 10 | Checking rnpm/rnpm ... 11 | Whoa look how they wrote "Xcode" 🔴 12 | 1. Why? Tooling is important. We all know this. One of the biggest advantages of native iOS development is XCode and its great tools. Unfortunately, the process of adding native dependencies to React Native projects is far from perfect and our aim is to make it fun again. 13 | Open pull request? (y/n) y 14 | Forking to ReadmeCritic/rnpm ... 15 | Committing change... 16 | Opening pull request... 17 | Done: https://github.com/rnpm/rnpm/pull/94 18 | ``` 19 | 20 | `xcode-readme` uses [`readme-correct`](https://github.com/dkhamsing/readme-correct). 21 | 22 | ### ~~xCode~~ ~~XCode~~ 23 | 24 | https://developer.apple.com/xcode/ 25 | 26 | > [![](assets/xcode-screenshot.png)](https://developer.apple.com/xcode/) 27 | 28 | ## Installation 29 | 30 | ```shell 31 | $ git clone https://github.com/dkhamsing/xcode-readme.git 32 | $ cd xcode-readme/ 33 | $ bundle install 34 | ``` 35 | 36 | This project requires GitHub credentials in [.netrc](https://github.com/octokit/octokit.rb#using-a-netrc-file). 37 | 38 | ## Examples 39 | 40 | Below are diffs for pull requests created with `xcode-readme` (see more [examples](https://github.com/issues?utf8=✓&q=xcode+author%3AReadmeCritic)). 41 | 42 | https://github.com/rnpm/rnpm/pull/94 43 | 44 | ```diff 45 | 46 | ## Rationale 47 | 48 | -Why? Tooling is important. We all know this. One of the biggest advantages of native iOS development is XCode and its great tools. Unfortunately, the process of adding native dependencies to React Native projects is far from perfect and our aim is to make it fun again. 49 | +Why? Tooling is important. We all know this. One of the biggest advantages of native iOS development is Xcode and its great tools. Unfortunately, the process of adding native dependencies to React Native projects is far from perfect and our aim is to make it fun again. 50 | ``` 51 | 52 | https://github.com/FutureKit/FutureKit/pull/36 53 | 54 | ```diff 55 | FutureKit uses Swift generic classes, to allow you to easily deal with asynchronous/multi-threaded issues when coding for iOS or OSX. 56 | 57 | -- is 100% Swift. It ONLY currently supports Swift 2.0 and XCode 7+. Swift 1.2 branch wont be supported anymore. (Too many issues with generics made swift 1.2 less than perfect) We are also only supporting swift 2.0+ compatble SDKs (iOS 8.0+, OSX 10.x.) 58 | +- is 100% Swift. It ONLY currently supports Swift 2.0 and Xcode 7+. Swift 1.2 branch wont be supported anymore. (Too many issues with generics made swift 1.2 less than perfect) We are also only supporting swift 2.0+ compatble SDKs (iOS 8.0+, OSX 10.x.) 59 | 60 | - is type safe. It uses Swift Generics classes that can automatically infer the type you wish to return from asynchronous logic. And supports both value and reference Swift types (Both 'Any' types, and 'AnyObject/NSObject' types.) 61 | 62 | -- works well editing code within XCode auto-completion. The combination of type-inference and code-completion makes FutureKit coding fast and easy. 63 | +- works well editing code within Xcode auto-completion. The combination of type-inference and code-completion makes FutureKit coding fast and easy. 64 | 65 | # Documentation 66 | 67 | -FutureKit documentation is being written as XCode Playgrounds. The best way to start is to open the FutureKit.workspace and then opening the Playground inside. (If you open the Playgrounds outside of the workspace, then FutureKit module may not import correctly). 68 | -The XCode Playgrounds probably require XCode 6.3 (in order to see the Markup correctly) 69 | +FutureKit documentation is being written as Xcode Playgrounds. The best way to start is to open the FutureKit.workspace and then opening the Playground inside. (If you open the Playgrounds outside of the workspace, then FutureKit module may not import correctly). 70 | +The Xcode Playgrounds probably require Xcode 6.3 (in order to see the Markup correctly) 71 | 72 | -If you are impatient, or not near your copy of XCode, you can try to read the first intro "raw" playground here: 73 | +If you are impatient, or not near your copy of Xcode, you can try to read the first intro "raw" playground here: 74 | ``` 75 | 76 | https://github.com/atelierdumobile/AppXperienceFramework/pull/1 77 | 78 | ```diff 79 | ### Pod Installation (recommended) 80 | 81 | The recommended way of installation is via [CocoaPods](http://cocoapods.org). 82 | -Pods lets you download and integrate Appxperience in your xCode project in less than 1 minute. 83 | +Pods lets you download and integrate Appxperience in your Xcode project in less than 1 minute. 84 | ``` 85 | 86 | ## Contact 87 | 88 | - [github.com/dkhamsing](https://github.com/dkhamsing) 89 | - [twitter.com/dkhamsing](https://twitter.com/dkhamsing) 90 | 91 | ## License 92 | 93 | This project is available under the MIT license. See the [LICENSE](LICENSE) file for more info. 94 | -------------------------------------------------------------------------------- /Rakefile: -------------------------------------------------------------------------------- 1 | require 'bundler/gem_tasks' 2 | -------------------------------------------------------------------------------- /assets/xcode-screenshot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dkhamsing/xcode-readme/577e53ec33fdde8ed8da3adcdc2b2a99be06122a/assets/xcode-screenshot.png -------------------------------------------------------------------------------- /bin/xcode-readme: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby 2 | $LOAD_PATH.push File.expand_path('../../lib', __FILE__) 3 | 4 | require 'readme-correct' 5 | 6 | ReadmeCorrect.cli 7 | -------------------------------------------------------------------------------- /correct.yml: -------------------------------------------------------------------------------- 1 | correct: Xcode 2 | incorrect: 3 | - XCode 4 | - xCode 5 | pull_commit_message: Correct the capitalization of Xcode in README 6 | pull_request_title: Correct the capitalization of Xcode in README 7 | pull_request_description: | 8 | This pull request corrects the capitalization of **Xcode** :sweat_smile: 9 | https://developer.apple.com/xcode/ 10 | Created with [`xcode-readme`](https://github.com/dkhamsing/xcode-readme). 11 | -------------------------------------------------------------------------------- /xcode-readme.gemspec: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | lib = File.expand_path('../lib', __FILE__) 3 | $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib) 4 | 5 | Gem::Specification.new do |spec| 6 | spec.name = 'xcode-readme' 7 | spec.version = '0.1.0' 8 | spec.authors = ["dkhamsing"] 9 | spec.email = ["dkhamsing8@gmail.com"] 10 | 11 | spec.summary = 'Correct capitalization of Xcode in a README' 12 | spec.description = spec.summary 13 | spec.homepage = 'https://github.com/dkhamsing/xcode-readme' 14 | 15 | spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) } 16 | spec.bindir = 'bin' 17 | spec.executables = [spec.name] 18 | spec.require_paths = ['lib'] 19 | 20 | spec.add_runtime_dependency 'github-readme', '~> 0.1.0.pre' 21 | end 22 | --------------------------------------------------------------------------------