Skip to content

Commit

Permalink
v4 readme
Browse files Browse the repository at this point in the history
  • Loading branch information
TheBlindHawk committed Jul 1, 2024
1 parent f8bbe90 commit 9cd6862
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 15 deletions.
25 changes: 11 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
> [!IMPORTANT]
> As of July 1st **@theblindhawk/roulette** has been renamed into **roulette-spinner** therefore marked as deprecated (the github repository will stay the same).
> The following changes will be applied on the new package:
> 1. the license will be changed from ISC to MIT for convenience
> 2. a few keywords such as "roll" will be changing into "spin"
> 3. Vue and React utilities will be coming in the form of new packages (roulette-spinner-react and roulette-spinner-vue)
>
> Apologies for the inconvenience!
<h1 align="center">Customizable Roulette Library</h1>

<div align="center">
Expand All @@ -9,6 +18,8 @@

</div>

for the updated version check out the [roulette-spinner](https://www.npmjs.com/package/roulette-spinner) library.

```
npm install @theblindhawk/roulette
```
Expand All @@ -20,15 +31,6 @@ npm install @theblindhawk/roulette

</div>

> [!WARNING]
> **@theblindhawk/roulette** will soon be renamed into **roulette-spinner** therefore marked as deprecated (the github repository will stay the same).
> The following changes will be applied on the new package:
> 1. the license will be changed from ISC to MIT for convenience
> 2. a few keywords such as "roll" will be changing into "spin"
> 3. Vue and React utilities will be coming in the form of new packages (roulette-spinner-react and roulette-spinner-vue)
>
> Apologies for the inconvenience!
## v3.0 Features

- **Compatible** with Javascript, TypeScript
Expand All @@ -41,11 +43,6 @@ npm install @theblindhawk/roulette

NB: check out the [change log](https://github.com/TheBlindHawk/Roulette/releases/tag/v%2F3.0.0) to see what changed from version 2!

## v4.0 Objectives (by June)

- library name change @theblindhawk/roulette => roulette-spinner
- separate packages for react and vue implementations

## Table of Contents
- [Features](#features)
- [Planned Features](#planned-features)
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@theblindhawk/roulette",
"version": "3.1.0",
"version": "3.1.1",
"description": "a thoroughly customizable roulette wheel",
"main": "dist/index.js",
"types": "dist/index.d.ts",
Expand Down

0 comments on commit 9cd6862

Please sign in to comment.