@onbeam/player-api-client - npm Package Compare versions

Comparing version 1.2.4 to 1.2.5

package.json

		@@ -26,3 +26,3 @@ {
		},
		"version": "1.2.4",
		"version": "1.2.5",
		"scripts": {
		@@ -29,0 +29,0 @@ "generate": "pnpm generate:client && pnpm generate:barrels && pnpm build",

README.md

		@@ -1,10 +0,20 @@
		# Beam self-custodial (beta)
		# Beam Player API (beta)

		The Beam Player API request client is meant to be implemented in server side environments. It allows you to read data through our service, and generate Operations for your users.


		## Beam SDK

		If you're looking to implement Beam in a client side application, for example: a web application, please refer to the [Beam SDK for web](https://www.npmjs.com/package/@onbeam/sdk).

		## Getting started

		In order to get started with the Player API request client, we highly recommend you to read [our documentation](https://docs.onbeam.com/service/introduction-player-api). If you can't wait to get your hands dirty, here's an easy-going snippet that should get you going.

		```typescript
		import { Beam as BeamSelfCustody } from '@onbeam/self-custody'
		import { Beam } from '@onbeam/player-api-client'

		const beam = new BeamSelfCustody('your-publishable-api-key');
		const beam = new Beam('your-publishable-api-key');

		const game = await beam.operations.getOperatoin(opId);
		const operation = await beam.operations.getOperation('your-operation-id');
		```

New alerts