chore: Rename git repo + improve docs (#5)

* chore: use repo 'react-native-actions-shortcuts'

* chore: remove log

* chore: ignore .iml files

* chore: rename android package + update gradle

* chore: update ios example

* chore: improve README

* chore: add screenshots to example README

Author: mouselangelo

.gitignore

@@ -35,6 +35,7 @@ project.xcworkspace
 .gradle
 local.properties
 android.iml
+*.iml
 
 # Cocoapods
 #

CONTRIBUTING.md

@@ -51,7 +51,7 @@ yarn test
 
 To edit the Objective-C files, open `example/ios/ShortcutsExample.xcworkspace` in XCode and find the source files at `Pods > Development Pods > react-native-actions-shortcuts`.
 
-To edit the Kotlin files, open `example/android` in Android studio and find the source files at `reactnativeshortcuts` under `Android`.
+To edit the Kotlin files, open `example/android` in Android studio and find the source files at `reactnativeactionsshortcuts` under `Android`.
 
 ### Commit message convention
 

README.md

@@ -1,6 +1,6 @@
 # react-native-actions-shortcuts
 
-iOS Home screen Quick Actions & Android App Shortcuts for react-native
+iOS [Home screen Quick Actions](https://developer.apple.com/design/human-interface-guidelines/ios/system-capabilities/home-screen-actions/) & Android [App Shortcuts](https://developer.android.com/guide/topics/ui/shortcuts/creating-shortcuts) for react-native
 
 ## Installation
 
@@ -14,9 +14,11 @@ npm install react-native-actions-shortcuts
 
 If you are using cocoapods - you may need to run `pod install` (from `ios` directory).
 
-On iOS, Quick Actions are handled by your app's `UIApplicationDelegate`
-(`AppDelegate.m`) - you will therefore need to add the following code in your
-project's `` file.
+On iOS, Quick Actions are handled by the
+[`application:performActionForShortcutItem:completionHandler`](https://developer.apple.com/documentation/uikit/uiapplicationdelegate/1622935-application?language=objc)
+method of your app's [`UIApplicationDelegate`](https://developer.apple.com/documentation/uikit/uiapplicationdelegate) (i.e. `AppDelegate.m`),
+so, you will therefore need to add the following code in your
+project's [`AppDelegate.m`](./example/ios/ShortcutsExample/AppDelegate.m)) file.
 
 ```objective-c
 - (void)application:(UIApplication *)application performActionForShortcutItem:(UIApplicationShortcutItem *)shortcutItem completionHandler:(void (^)(BOOL))completionHandler {
@@ -30,9 +32,13 @@ Android doesn't require any additional setup.
 
 ## Usage
 
-Check out the [Example project](./example/README.md).
+### Example project
 
-Imports
+See the [Example project](./example/README.md) for a working demo.
+
+### Documentation
+
+#### Imports
 
 ```js
 // ...
@@ -45,14 +51,17 @@ import Shortcuts, { ShortcutItem } from "react-native-actions-shortcuts";
 // ...
 ```
 
-Get the initial shortcut that the app was launched with.
-On iOS this will be returned just once, subsequent calls will return `null`.
+#### Initial shortcut / action
+
+Get the initial shortcut that the app was launched with. On iOS this will be returned just once, subsequent calls will return `null`.
 
 ```js
 const shortcutItem = await Shortcuts.getInitialShortcut();
 ```
 
-Listen to action invocations while app is running.
+#### Listen for shortcut / action invocations
+
+Listen to shortcut / action invocations while app is running.
 
 On iOS the listener is also called for the initial
 invocation, unless it was already received via `Shortcuts.getInitialShortcut()`.
@@ -73,6 +82,8 @@ ShortcutsEmitter.addListener("onShortcutItemPressed", handleShortcut);
 ShortcutsEmitter.removeListener("onShortcutItemPressed", handleShortcut);
 ```
 
+#### Set shortcuts
+
 To set shortcuts (will replace existing dynamic actions / shortcuts)
 
 ```js
@@ -93,15 +104,18 @@ Shortcuts.setShortcuts([shortcutItem]);
 const shortcutItems = await Shortcuts.setShortcuts([shortcutItem]);
 ```
 
-To clear shortcuts
+#### Clear shortcuts
+
+Clears all dynamic shortcuts.
 
 ```js
 Shortcuts.clearShortcuts();
 ```
 
-Get the current shortcuts.
+#### Get shortcuts
 
-Some information may be lost, such as iconName, data
+Get the current shortcuts. Some information may be lost, such as iconName, data,
+etc.
 
 ```js
 const shortcutItems = await Shortcuts.getShortcuts();
@@ -113,19 +127,29 @@ To display icons with your shortcuts / actions you will need to add them to your
 project. Once added use the name of your iOS asset or Android drawable as the
 value for `iconName` above.
 
-### iOS - Asset library
+### iOS - Asset catalog
 
-Add new assets to your Asset library by importing either `png` (scalar) or
+Add new assets to your [Asset catalog](https://developer.apple.com/library/archive/documentation/ToolsLanguages/Conceptual/Xcode_Overview/AddingImages.html) by importing either `png` (scalar) or
 `pdf` (vector) files.
 
+Refer
+[Custom Icons : Home Screen Quick Action Icon
+Size](https://developer.apple.com/design/human-interface-guidelines/ios/icons-and-images/custom-icons/)
+to learn about the dimensions and design specifications.
+
 ### Android - drawable
 
-Add drawable resources to you Android project. In Android studio, choose:
+Add [drawable resources](https://developer.android.com/studio/write/resource-manager) to you Android project. In Android studio, choose:
 
 - for vector icons (SVG / PDF): __File > New > Vector Asset__
 
 - for scalar icons (PNG): __File > New > Image Asset__
 
+Refer
+[App Shortcuts: Icon design
+guidelines](https://commondatastorage.googleapis.com/androiddevelopers/shareables/design/app-shortcuts-design-guidelines.pdf)
+to learn about the dimensions and design specifications.
+
 ## Contributing
 
 See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.

android/build.gradle

@@ -8,7 +8,7 @@ buildscript {
   }
 
   dependencies {
-    classpath 'com.android.tools.build:gradle:3.2.1'
+    classpath 'com.android.tools.build:gradle:3.5.3'
     // noinspection DifferentKotlinGradleVersion
     classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
   }