Skip to content

Commit a4568bf

Browse files
committed
Make the package publish ready.
1 parent 9ac2a6d commit a4568bf

File tree

4 files changed

+13
-22
lines changed

4 files changed

+13
-22
lines changed

README.md

+8-19
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
# Poki Phaser 3 Plugin
2+
A Phaser 3 plugin to easially integrate the Poki SDK
3+
4+
- - -
25

36
Hi! 👋 This is the official Poki Phaser Plugin for
47
[Phaser 3](https://phaser.io/phaser3). This plugin will automate most of
@@ -26,12 +29,12 @@ always check the example in the [/example](example/) directory.
2629

2730
### Add the dependency
2831

29-
First, you have to make sure to add the `poki-phaser-3` plugin as a dependency
30-
to your project:
32+
First, you have to make sure to add the `@poki/phaser-3` plugin as a dependency
33+
to your project:
3134
```bash
32-
$ npm install --save-dev poki-phaser-3
35+
$ npm install --save-dev @poki/phaser-3
3336
# or
34-
$ yarn add --dev poki-phaser-3
37+
$ yarn add --dev @poki/phaser-3
3538
```
3639
<small>(note: at the time of writing, not yet published to npm)</small>
3740

@@ -40,7 +43,7 @@ $ yarn add --dev poki-phaser-3
4043
Step two is to add the plugin to the plugins section of your Phaser
4144
configuration, for example:
4245
```javascript
43-
import { PokiPlugin } from 'poki-phaser-3'
46+
import { PokiPlugin } from '@poki/phaser-3'
4447
// ...
4548
const config = {
4649
// ...
@@ -132,20 +135,6 @@ Server running at http://localhost:1234
132135
And point your browser to http://localhost:1234
133136

134137

135-
## TODO
136-
137-
This project is currently in an early development phase. These steps are still
138-
left before we can publish it for general use:
139-
140-
- [x] Get it to work localhost
141-
- [x] Auto mute & Disable keyboard input
142-
- [x] Extend example with buttons to show off all plugin features (e.g. rewarded
143-
ad)
144-
- [x] Write readme & instructions
145-
- [x] Go over all exposed function/variable names
146-
- [ ] Package into downloadable .js and publish to npm
147-
- [ ] Test it in an existing game
148-
149138
## Asset Credits
150139

151140
Background music credits:
-2.71 MB
Binary file not shown.

example/game.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import Phaser from 'phaser'
33
import { PokiPlugin } from '../lib'
44
// In this example we use '../lib' because it's in the same repository, in
55
// an actual project you should use:
6-
// import { PokiPlugin } from 'poki-phaser-3'
6+
// import { PokiPlugin } from '@poki/phaser-3'
77

88
import LoadingScene from './scenes/loading'
99

package.json

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
{
2-
"name": "phaser-plugin",
2+
"name": "@poki/phaser-3",
3+
"repository": "https://github.com/poki/phaser-plugin",
4+
"description": "A Phaser 3 plugin to easially integrate the Poki SDK",
35
"version": "0.0.1",
46
"source": "lib/index.js",
57
"main": "dist/phaser-poki.js",
68
"license": "ISC",
7-
"private": true,
89
"scripts": {
910
"watch": "parcel ./example/index.html",
11+
"build-publish": "rm -rf dist && parcel build && yarn publish",
1012
"lint": "standard"
1113
},
1214
"dependencies": {

0 commit comments

Comments
 (0)