minor package.json & readme edits

This commit is contained in:
Adam Piontek 2022-09-08 06:58:31 -04:00
parent 01770ff9bd
commit 121cda7e3e
2 changed files with 15 additions and 4 deletions

View file

@ -10,9 +10,9 @@ The most significant addition is that this solver will return one possible "best
This can help with games where the goal is not clearing the board, but clearing a certain set of cards or hitting a threshold of points.
*NOTE:* The "best path" returned is the first one found that clears the most cards. Hypothetically, a board could have multiple paths to clear the same number of cards. The path the solver returns might not clear the cards you need to clear. A possible future improvement could be returning, say, the top 5 best paths.
_NOTE:_ The "best path" returned is the first one found that clears the most cards. Hypothetically, a board could have multiple paths to clear the same number of cards. The path the solver returns might not clear the cards you need to clear. A possible future improvement could be returning, say, the top 5 best paths.
*NOTE:* Unsolvable boards can take a long time to process, so be patient. The sample unsolvable board below takes my computer almost 6 minutes to conclude.
_NOTE:_ Unsolvable boards can take a long time to process, so be patient. The sample unsolvable board below takes my computer almost 6 minutes to conclude.
## Playing

View file

@ -1,7 +1,14 @@
{
"name": "javascript-tri-peaks-solitaire-solver",
"version": "1.0.1",
"description": "A brute force solver for tri peaks solitaire written in javascript",
"description": "A brute force solver for tri peaks solitaire written in javascript. Forked from work by Courtney Pitcher at https://github.com/IgniparousTempest/javascript-tri-peaks-solitaire-solver",
"keywords": [
"tripeaks",
"solitaire",
"game",
"solver",
"cards"
],
"main": "solver.js",
"scripts": {
"test": "mocha",
@ -12,7 +19,11 @@
"type": "git",
"url": "git+https://github.com/apiontek/javascript-tri-peaks-solitaire-solver.git"
},
"author": "Adam Piontek, Courtney Pitcher",
"author": {
"name": "Adam Piontek",
"email": "adam@73k.us",
"url": "https://73k.us/"
},
"license": "ISC",
"bugs": {
"url": "https://github.com/apiontek/javascript-tri-peaks-solitaire-solver/issues"