@northflank/js-client 0.3.5 → 0.5.0

package/README.md

@@ -1,5 +1,5 @@
-## Northflank api-client package
-Node.js client for the Northflank platform based on the Northflank public api.
+## Northflank API js-client package
+Node.js client for the Northflank platform based on the Northflank public API.
 
 *Visit our website [www.northflank.com](https://www.northflank.com)*
 
@@ -17,8 +17,8 @@ Add as a dependency to your project with
 
 ### Using the package
 Example usage: 
-```
-import { ApiClient, ApiClientInMemoryContextProvider} from '@northflank/js-client';
+```javascript
+import { ApiClient, ApiClientInMemoryContextProvider } from '@northflank/js-client';
 
 (async () => {
   // Create context to store credentials.
@@ -32,7 +32,7 @@ import { ApiClient, ApiClientInMemoryContextProvider} from '@northflank/js-clien
   const apiClient = new ApiClient(contextProvider);
 
   // Retrieve list of projects and log to console.
-  const projects = (await apiClient.list.project({})).data.projects;
+  const projects = (await apiClient.list.projects({})).data.projects;
   console.log(projects);
 
   // Create a new project.
@@ -45,7 +45,7 @@ import { ApiClient, ApiClientInMemoryContextProvider} from '@northflank/js-clien
   });
 
   // List services in newly created project
-  const { services } = (await apiClient.list.service({ parameters: { projectId: project.data.id } })).data;
+  const { services } = (await apiClient.list.services({ parameters: { projectId: project.data.id } })).data;
   console.log(services.map((svc) => svc.name).join(', '));
 })();
 ```