From 792d8646e70000ff99677fe0026a0785720ed6e6 Mon Sep 17 00:00:00 2001
From: Eli <78963198+niceEli@users.noreply.github.com>
Date: Thu, 23 May 2024 21:28:02 -0400
Subject: [PATCH] chore: rebrand readme to feature new links
basically i replaced kaboom with kaplay and changed the links, i also used obsidian so thats why i ignored obsidian files
---
.gitignore | 3 ++-
README.md | 19 ++++++++++---------
2 files changed, 12 insertions(+), 10 deletions(-)
diff --git a/.gitignore b/.gitignore
index a275ed82..fed80aad 100644
--- a/.gitignore
+++ b/.gitignore
@@ -7,4 +7,5 @@ desktop/
.vscode
src-tauri/target/
.replit
-replit.nix
\ No newline at end of file
+replit.nix
+/.obsidian
diff --git a/README.md b/README.md
index ff9f885c..5579b51f 100644
--- a/README.md
+++ b/README.md
@@ -6,9 +6,9 @@
> For now, there's links to the Kaboom documentation and examples, but in the future, they will be linked
> to our own site.
-[**Kaboom**](https://kaboomjs.com) is a JavaScript library that helps you make games fast and fun!
+[**Kaplay**](https://kaplaydocs.pages.dev/) is a JavaScript library that helps you make games fast and fun!
-Start playing around with it in the [Kaboom Playground](https://kaboomjs.com/play)
+Start playing around with it in the [Kaplayground](https://kaplay.pages.dev/)
## Examples
@@ -37,7 +37,7 @@ onKeyPress("space", () => {
});
```
-Kaboom uses a powerful component system to compose game objects and behaviors.
+kaplay uses a powerful component system to compose game objects and behaviors.
```js
// add a game obj to the scene from a list of component
@@ -119,11 +119,11 @@ Then open http://localhost:5173 and edit `src/game.js`
### Install as NPM Package
```sh
-$ npm install kaboom
+$ npm install kaplay
```
```js
-import kaboom from "kaboom";
+import kaboom from "kaplay";
kaboom();
@@ -136,7 +136,7 @@ add([
also works with CommonJS
```js
-const kaboom = require("kaboom");
+const kaboom = require("kaplay");
```
Note that you'll need to use a bundler like `esbuild` or `webpack` to use Kaboom with NPM
@@ -146,7 +146,7 @@ Note that you'll need to use a bundler like `esbuild` or `webpack` to use Kaboom
This exports a global `kaboom` function
```html
-
+
@@ -156,7 +156,7 @@ or use with es modules
```html
```
@@ -165,6 +165,7 @@ works all CDNs that supports NPM packages, e.g. jsdelivr, skypack
## Documentation
+- **v3001**: https://kaplaydocs.pages.dev/
- **v3000**: https://kaboomjs.com/
- **v2000**: https://2000.kaboomjs.com/
- **v0.5.0**: https://legacy.kaboomjs.com/
@@ -181,7 +182,7 @@ Check out [CONTRIBUTION.md](CONTRIBUTING.md) for full info.
## Community
- [Discord Server](https://discord.gg/aQ6RuQm3TF)
-- [GitHub Discussions](https://github.com/replit/kaboom/discussions)
+- [GitHub Discussions](https://github.com/marklovers/kaplay/discussions)
- [Twitter](https://twitter.com/Kaboomjs)
### Games