Skip to content

Commit 51ac163

Browse files
committed
updated readme
1 parent 670b9a7 commit 51ac163

1 file changed

Lines changed: 41 additions & 22 deletions

File tree

README.md

Lines changed: 41 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -2,40 +2,57 @@
22

33
![bottlecap.js](https://github.com/harshsinghdev/bottlecap/raw/main/banner_new.png)
44

5-
### Table of Contents
6-
- [About](#about)
7-
- [Installation](#installation)
8-
- [Docs](#Docs)
5+
## Table of Contents
6+
- [About](#about)
7+
- [Installation and Setup](#installation-and-setup)
8+
- [NPM](#npm)
9+
- [CDN](#cdn)
10+
- [Docs](#docs)
911
- [Example](#example)
1012

11-
### About
13+
## About
1214

13-
bottlecap is a minimalist 2d game framework written in ES6. it is a collection of tiny components (called **bottlecaps**) you can combine to create a 2d game.
15+
**bottlecap.js** is a lightweight 2D game framework written in ES6. It offers a set of modular components, referred to as **bottlecaps**, that can be easily combined to create engaging 2D games.
1416

15-
### Installation
17+
## Installation and Setup
18+
19+
### NPM
1620

17-
**NPM**
1821
```bash
22+
npm create vite@latest my-bottlecap-game -- --template vanilla # vanilla-ts for TypeScript
23+
1924
npm i bottlecap
2025
```
2126

22-
**CDN**
27+
**src/main.js:**
28+
29+
```javascript
30+
import * as Bottlecap from 'bottlecap';
31+
32+
// your code
33+
```
34+
35+
### CDN
36+
37+
**src/main.js:**
38+
2339
```javascript
2440
import * as Bottlecap from 'https://unpkg.com/bottlecap@latest';
2541

2642
// your code
2743
```
2844

29-
### Docs
30-
You can read the Docs at bottlecap.js's [wiki](https://github.com/harshsinghdev/bottlecap/wiki).
45+
## Docs
3146

32-
### Example
47+
Explore the comprehensive documentation in the [wiki](https://github.com/harshsinghdev/bottlecap/wiki) to get started with **bottlecap.js**.
3348

34-
Try Out This [Live Demo](https://replit.com/@harshsinghdev/bottlecap-example1) on Replit.
35-
![Demo](https://github.com/harshsinghdev/bottlecap/raw/gh-pages/images/demo-screenshot.png)
49+
## Example
50+
51+
Check out a live demo on [Replit](https://replit.com/@harshsinghdev/bottlecap-example1).
3652

37-
**game.js**
53+
![Demo](https://github.com/harshsinghdev/bottlecap/raw/gh-pages/images/demo-screenshot.png)
3854

55+
**game.js:**
3956
```javascript
4057
import * as Bottlecap from 'https://unpkg.com/bottlecap@latest';
4158

@@ -216,8 +233,7 @@ const initGame = () => {
216233
Bottlecap.DOM.ready(initGame);
217234
```
218235

219-
**index.html**
220-
236+
**index.html:**
221237
```html
222238
<!Doctype html>
223239
<html>
@@ -232,8 +248,11 @@ Bottlecap.DOM.ready(initGame);
232248
</html>
233249
```
234250

235-
### Games made using bottlecap
236-
* [Hydrogen](https://hypervoid.itch.io/hydrogen)
237-
* [Play Or Die](https://hypervoid.itch.io/play-or-die)
238-
* [Sneaky Tails](https://hypervoid.itch.io/sneaky-tails)
239-
* [SlideToShoot](https://hypervoid.itch.io/slide-to-shoot)
251+
## Games made using bottlecap
252+
253+
- [Hydrogen](https://hypervoid.itch.io/hydrogen)
254+
- [Play Or Die](https://hypervoid.itch.io/play-or-die)
255+
- [Sneaky Tails](https://hypervoid.itch.io/sneaky-tails)
256+
- [SlideToShoot](https://hypervoid.itch.io/slide-to-shoot)
257+
258+
Feel inspired by these creations? Start your own journey with **bottlecap.js** and join the growing community of game developers. Share your masterpiece and let the world experience your unique vision! If you have a game developed using **bottlecap.js** that you'd like to showcase, consider adding it to the list by opening a pull request. Happy gaming!

0 commit comments

Comments
 (0)