Skip to content
This repository has been archived by the owner on Aug 8, 2023. It is now read-only.

Include iOS README in binary pod #1886

Merged
merged 1 commit into from
Jul 13, 2015
Merged

Include iOS README in binary pod #1886

merged 1 commit into from
Jul 13, 2015

Conversation

1ec5
Copy link
Contributor

@1ec5 1ec5 commented Jul 13, 2015

This PR adds the iOS-specific README to the build folder that gets zipped up and distributed as a CocoaPods binary pod. Without this README, CocoaPods dings the MapboxGL pod big time in its quality metrics for lacking a README. We’ve been compiling this README to serve as the index page of the API documentation that gets generated, but a README also needs to set right alongside the library and resource bundle.

/cc @incanus @friedbunny

@1ec5 1ec5 added bug iOS Mapbox Maps SDK for iOS build labels Jul 13, 2015
@1ec5 1ec5 self-assigned this Jul 13, 2015
@1ec5 1ec5 added this to the iOS Beta 4 milestone Jul 13, 2015
@friedbunny
Copy link
Contributor

👍

https://guides.cocoapods.org/making/quality-indexes.html

README Scoring

The README score is based on an algorithm that looks at the variety of the bundled README. You can run the algorithm against any URL here on scoreme.report. A README is the front-page of your library, it can provide an overview of API or show what the library can do.

Strange as it sounds, if you are providing a binary CocoaPod, it is worth embedding your README.md inside the zip. This means CocoaPods can use it to generate your Pod page.

@1ec5 1ec5 force-pushed the 1ec5-pod-readme branch from 1c24b8c to 27bd305 Compare July 13, 2015 21:25
@1ec5 1ec5 merged commit 27bd305 into master Jul 13, 2015
@1ec5 1ec5 removed the in progress label Jul 13, 2015
@1ec5 1ec5 deleted the 1ec5-pod-readme branch July 13, 2015 21:50
@incanus
Copy link
Contributor

incanus commented Jul 21, 2015

Great work — just noticed this ranking business recently myself. Good discussion on the mailing list at https://groups.google.com/forum/#!topic/cocoapods/Pvjsd57zKAk as well.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug build iOS Mapbox Maps SDK for iOS
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants