Skip to content

Commit

Permalink
updated package name
Browse files Browse the repository at this point in the history
Signed-off-by: Scott Westover <[email protected]>
  • Loading branch information
scottwestover committed Dec 28, 2023
1 parent 0cc167e commit be1b2b9
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,19 @@ A NPM package that contains the core game logic for the game 2048.

```bash
# npm
npm install -E @devshareacademy/2048
npm install -E @devshareacademy/js-2048

# yarn
yarn add -E @devshareacademy/2048
yarn add -E @devshareacademy/js-2048

# pnpm
pnpm add -E @devshareacademy/2048
pnpm add -E @devshareacademy/js-2048
```

## Usage

```typescript
import { Game2048 } from '@devshareacademy/2048';
import { Game2048 } from '@devshareacademy/js-2048';

const game = new Game2048();

Expand Down Expand Up @@ -64,7 +64,7 @@ The `Game2048` class allows for you to configure the following settings for your
Example:

```typescript
import { Game2048 } from '@devshareacademy/connect-four';
import { Game2048 } from '@devshareacademy/js-2048';

const game = new Game2048({ cols: 2, rows: 2, numberToReachToWin: 8 });

Expand Down Expand Up @@ -112,7 +112,7 @@ Allows the player to reset the game, and start a brand new game.
### Simple Game

```typescript
import { Game2048 } from '@devshareacademy/connect-four';
import { Game2048 } from '@devshareacademy/js-2048';

const game = new Game2048();
game.makeMove('DOWN');
Expand Down Expand Up @@ -186,7 +186,7 @@ npm link
# change to the directory of the project you want to use this package in
cd ../../../some-other-project
# link-install the package
npm link @devshareacademy/2048
npm link @devshareacademy/js-2048
```

Please see the official documentation on [npm link](https://docs.npmjs.com/cli/v8/commands/npm-link) for more information.
Expand Down Expand Up @@ -220,7 +220,7 @@ npm publish --registry http://localhost:4873
To install the local package in another project:

```bash
NPM_CONFIG_REGISTRY=http://localhost:4873 npm install @devshareacademy/connect-four
NPM_CONFIG_REGISTRY=http://localhost:4873 npm install @devshareacademy/js-2048
```

## Project Structure
Expand Down
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "@devshareacademy/2048",
"name": "@devshareacademy/js-2048",
"version": "0.0.2",
"description": "A NPM package that contains the core game logic for the game 2048.",
"files": [
Expand All @@ -18,9 +18,9 @@
"license": "MIT",
"repository": {
"type": "git",
"url": "https://github.com/devshareacademy/2048.git"
"url": "git+https://github.com/devshareacademy/js-2048.git"
},
"homepage": "https://github.com/devshareacademy/2048",
"homepage": "https://github.com/devshareacademy/js-2048",
"devDependencies": {
"@devshareacademy/eslint-config": "0.0.16",
"@devshareacademy/prettier-config": "0.0.4",
Expand Down

0 comments on commit be1b2b9

Please sign in to comment.