Skip to content

Commit

Permalink
rebrand to ReScript from BuckleScript
Browse files Browse the repository at this point in the history
  • Loading branch information
mikaello committed Jan 2, 2021
1 parent 2421134 commit 66e7ac7
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 16 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
# bs-tinycolor
# rescript-tinycolor

[![NPM version](http://img.shields.io/npm/v/bs-tinycolor.svg)](https://www.npmjs.org/package/bs-tinycolor)
[![Build Status](https://travis-ci.com/mikaello/bs-tinycolor.svg?branch=master)](https://travis-ci.com/mikaello/bs-tinycolor)
[![NPM version](http://img.shields.io/npm/v/rescript-tinycolor.svg)](https://www.npmjs.org/package/rescript-tinycolor)
[![Build Status](https://travis-ci.com/mikaello/rescript-tinycolor.svg?branch=master)](https://travis-ci.com/mikaello/rescript-tinycolor)

Bucklescript bindings for [TinyColor](https://github.com/scttcper/tinycolor): fast, small color manipulation and conversion. See also [https://tinycolor.netlify.app](https://tinycolor.netlify.app)
ReScript bindings for [TinyColor](https://github.com/scttcper/tinycolor): fast, small color manipulation and conversion. See also [https://tinycolor.netlify.app](https://tinycolor.netlify.app)

## Getting started

```
yarn add bs-tinycolor
yarn add rescript-tinycolor
```

Then add `bs-tinycolor` as a dependency to `bsconfig.json`:
Then add `rescript-tinycolor` as a dependency to `bsconfig.json`:

```diff
"bs-dependencies": [
+ "bs-tinycolor"
+ "rescript-tinycolor"
]
```

## Example

```reason
open BsTinycolor;
open RescriptTinycolor;
let redString = TinyColor.makeFromString("red");
/* New instance made by name 'red' */
Expand Down Expand Up @@ -55,7 +55,7 @@ let isReadableInCombination = switch(redString, blueRgb) {
/* returns a bool telling whether these colors can be used for background/text */
```

See all available functions in the [original TinyColor repo](https://github.com/scttcper/tinycolor) and example usage of all functions in [the tests](https://github.com/mikaello/bs-tinycolor/blob/master/__tests__/Tinycolor_tests.re).
See all available functions in the [original TinyColor repo](https://github.com/scttcper/tinycolor) and example usage of all functions in [the tests](https://github.com/mikaello/rescript-tinycolor/blob/master/__tests__/Tinycolor_tests.re).

## Differences from original

Expand Down
2 changes: 1 addition & 1 deletion bsconfig.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "bs-tinycolor",
"name": "rescript-tinycolor",
"version": "0.1.0",
"sources": [
{
Expand Down
13 changes: 7 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "bs-tinycolor",
"version": "3.2.0",
"name": "rescript-tinycolor",
"version": "4.0.0",
"scripts": {
"build": "bsb -make-world",
"start": "bsb -make-world -w",
Expand All @@ -9,13 +9,14 @@
"test": "jest"
},
"keywords": [
"BuckleScript"
"ReScript",
"color-manipulation"
],
"author": "mikaello",
"description": "Fast, small color manipulation and conversion",
"homepage": "https://github.com/mikaello/bs-tinycolor",
"repository": "https://github.com/mikaello/bs-tinycolor",
"bugs": "https://github.com/mikaello/bs-tinycolor/issues",
"homepage": "https://github.com/mikaello/rescript-tinycolor",
"repository": "https://github.com/mikaello/rescript-tinycolor",
"bugs": "https://github.com/mikaello/rescript-tinycolor/issues",
"license": "MIT",
"devDependencies": {
"@glennsl/bs-jest": "^0.6.0",
Expand Down

0 comments on commit 66e7ac7

Please sign in to comment.