Merge pull request #24 from StatusNeo/feature/readme

readme modified and bug fix

Author: Abhay-soni-developer

README.md

@@ -19,6 +19,21 @@ Now in the below steps, I will assume you are already done with the provider.
 ```shell
 yarn add –cwd packages/app @statusneo/backstage-plugin-github
 ```
+2. add this to the app/src/apis.ts
+
+```javascript
+  import { githubApiRef, GithubClient as StatusNeoGithubClient } from '@statusneo/backstage-plugin-github';
+  
+  // ...
+  createApiFactory({
+    api: githubApiRef,
+    deps: { authApi: githubAuthApiRef, fetchApi: fetchApiRef, configApi: configApiRef },
+    factory(deps) {
+      return new StatusNeoGithubClient(deps);
+    },
+  }),
+  // ...
+```
 
 2. Import `GithubPullRequestsCard`, and `GithubActionsCard` from the installed package.
 
@@ -37,4 +52,13 @@ import { GithubPullRequestsCard, GithubActionsCard } from '@statusneo/backstage-
 // ...
 ```
 
+4. If you are using a GitHub enterprise edition, you can pass your instance url through app-config.yml
+
+```yaml
+
+gh-plugin:
+  url: ${GITHUB_ENTERPRISE_URL}
+
+```
+
 Now you are ready to use this Backstage GitHub plugin to make your software management and development cycle a little more hassle-free.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@statusneo/backstage-plugin-github",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "main": "src/index.ts",
   "types": "src/index.ts",
   "license": "ISC",

src/api/GithubClient.ts

@@ -36,7 +36,7 @@ export class GithubClient implements GithubApi {
     const query = new URLSearchParams(params);
 
     const baseUrl: string =
-      this.configApi.get('gh-plugin.url') || 'https://api.github.com/';
+      this.configApi.getOptionalString('gh-plugin.url') || 'https://api.github.com/';
 
     const url = new URL(
       `${path}?${query.toString().replaceAll('%2B', '+')}`,