Merge pull request #6 from openforge/fix/naming-pod-file

fix(): update name in podfile
openforge · Jul 14, 2023 · ffe026f · ffe026f
2 parents 8984791 + bab109e
commit ffe026f
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 14 deletions.
diff --git a/CapacitorGameConnect.podspec → OpenforgeCapacitorGameConnect.podspec b/CapacitorGameConnect.podspec → OpenforgeCapacitorGameConnect.podspec
@@ -3,7 +3,7 @@ require 'json'
 package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
 
 Pod::Spec.new do |s|
-  s.name = 'CapacitorGameConnect'
+  s.name = 'OpenforgeCapacitorGameConnect'
   s.version = package['version']
   s.summary = package['description']
   s.license = package['license']

diff --git a/README.md b/README.md
@@ -157,24 +157,25 @@ Before use the `Achievement Methods` of the plugin, you need to setup your Achie
 
 <docgen-index>
 
-- [`signIn()`](#signin)
-- [`showLeaderboard(...)`](#showleaderboard)
-- [`submitScore(...)`](#submitscore)
-- [`showAchievements()`](#showachievements)
-- [`unlockAchievement(...)`](#unlockachievement)
-- [`incrementAchievementProgress(...)`](#incrementachievementprogress)
+* [`signIn()`](#signin)
+* [`showLeaderboard(...)`](#showleaderboard)
+* [`submitScore(...)`](#submitscore)
+* [`showAchievements()`](#showachievements)
+* [`unlockAchievement(...)`](#unlockachievement)
+* [`incrementAchievementProgress(...)`](#incrementachievementprogress)
 
 </docgen-index>
 
 <docgen-api>
+<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
 
 ### signIn()
 
 ```typescript
 signIn() => Promise<void>
 ```
 
-- Method to sign-in a user
+* Method to sign-in a user
 
 --------------------
 
@@ -185,59 +186,63 @@ signIn() => Promise<void>
 showLeaderboard(options: { leaderboardID: string; }) => Promise<void>
 ```
 
-- Method to display the Leaderboards
+* Method to display the Leaderboards
 
 | Param         | Type                                    |
 | ------------- | --------------------------------------- |
 | **`options`** | <code>{ leaderboardID: string; }</code> |
 
 --------------------
 
+
 ### submitScore(...)
 
 ```typescript
 submitScore(options: { leaderboardID: string; totalScoreAmount: number; }) => Promise<void>
 ```
 
-- Method to submit a score to the Leaderboards table
+* Method to submit a score to the Google Play Services SDK
 
 | Param         | Type                                                              |
 | ------------- | ----------------------------------------------------------------- |
 | **`options`** | <code>{ leaderboardID: string; totalScoreAmount: number; }</code> |
 
 --------------------
 
+
 ### showAchievements()
 
 ```typescript
 showAchievements() => Promise<void>
 ```
 
-- Method to display the Achievements view
+* Method to display the Achievements view
 
 --------------------
 
+
 ### unlockAchievement(...)
 
 ```typescript
 unlockAchievement(options: { achievementID: string; }) => Promise<void>
 ```
 
-- Method to unlock an achievement
+* Method to unlock an achievement
 
 | Param         | Type                                    |
 | ------------- | --------------------------------------- |
 | **`options`** | <code>{ achievementID: string; }</code> |
 
 --------------------
 
+
 ### incrementAchievementProgress(...)
 
 ```typescript
 incrementAchievementProgress(options: { achievementID: string; pointsToIncrement: number; }) => Promise<void>
 ```
 
-- Method to increment the progress of an achievement
+* Method to increment the progress of an achievement
 
 | Param         | Type                                                               |
 | ------------- | ------------------------------------------------------------------ |

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@openforge/capacitor-game-connect",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Use Game Services and Game Connect",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",