Skip to content

Commit

Permalink
Remove automatic README generation (#365)
Browse files Browse the repository at this point in the history
  • Loading branch information
jcesarmobile committed Nov 1, 2018
1 parent c0d78ad commit 07e8574
Show file tree
Hide file tree
Showing 3 changed files with 1 addition and 475 deletions.
9 changes: 0 additions & 9 deletions README.md
Expand Up @@ -63,15 +63,6 @@ In order for your changes to be accepted, you need to sign and submit an Apache

**And don't forget to test and document your code.**


## This documentation is generated by a tool

⚠ Run `npm install` in the plugin repo to enable automatic docs generation if you plan to send a PR.
[jsdoc-to-markdown](https://www.npmjs.com/package/jsdoc-to-markdown) is used to generate the docs.
Documentation consists of template and API docs produced from the plugin JS code and should be regenerated before each commit (done automatically via [husky](https://github.com/typicode/husky), running `npm run gen-docs` script as a `precommit` hook - see `package.json` for details).



### iOS Quirks

Since iOS 10 it's mandatory to provide an usage description in the `info.plist` if trying to access privacy-sensitive data. When the system prompts the user to allow access, this usage description string will displayed as part of the permission dialog box, but if you didn't provide the usage description, the app will crash before showing the dialog. Also, Apple will reject apps that access private data but don't provide an usage description.
Expand Down

0 comments on commit 07e8574

Please sign in to comment.