Simplify parameters (referring to docs)

.gitignore

@@ -1,8 +1,10 @@
 # git diff files
 *.diff
 
+dist/
 node_modules/
 
 website/*.html
 website/css/chessboard.css
 website/js/chessboard.js
+website/examples/

.npmignore

@@ -0,0 +1,7 @@
+data/
+examples/
+scripts/
+templates/
+website/
+.editorconfig
+changes.diff

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 All notable changes to this project will be documented in this file.
 
-## [Unreleased]
+## [1.0.0] - 2019-06-11
 - Orientation methods now return current orientation. [Issue #64]
 - Drop support for IE8
 - Do not check for `window.JSON` (Error #1004)

LICENSE.md

@@ -1,4 +1,4 @@
-Copyright 2013 Chris Oakman
+Copyright 2019 Chris Oakman
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -17,4 +17,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,13 +1,18 @@
-# chessboard.js
+# chessboard.js [![npm](https://img.shields.io/npm/v/@chrisoakman/chessboardjs.svg)](https://www.npmjs.com/package/@chrisoakman/chessboardjs) [![MIT License](https://img.shields.io/npm/l/@chrisoakman/chessboardjs)](https://github.com/oakmac/chessboardjs/blob/master/LICENSE.md)
 
-chessboard.js is a JavaScript chessboard component. It depends on [jQuery].
+> **NOTE:** chessboard.js can be found on npm as `@chrisoakman/chessboardjs`
+
+chessboard.js is a JavaScript chessboard component. It depends on [jQuery] v3.4.1 (or higher).
 
 Please see [chessboardjs.com] for documentation and examples.
 
-## What is chessboard.js?
+## Project Status (Dec 2022)
 
-chessboard.js is a JavaScript chessboard component with a flexible "just a
-board" API that
+I am currently focusing my efforts on [chessboard2].
+
+[chessboard2]:https://github.com/oakmac/chessboard2
+
+## What is chessboard.js?
 
 chessboard.js is a standalone JavaScript Chess Board. It is designed to be "just
 a board" and expose a powerful API so that it can be used in different ways.
@@ -27,47 +32,38 @@ ease.
 ## What can chessboard.js **not** do?
 
 The scope of chessboard.js is limited to "just a board." This is intentional and
-makes chessboard.js flexible for handling a multitude of chess-related problems.
-
-This is a common source of confusion for new users. [remove?]
-
-Specifically, chessboard.js does not understand anything about how the game of
-chess is played: how a knight moves, who's turn is it, is White in check?, etc.
+makes chessboard.js flexible for building a variety of chess-related
+applications.
 
-Fortunately, the powerful [chess.js] library deals with exactly this sort of
-problem domain and plays nicely with chessboard.js's flexible API. Some examples
-of chessboard.js combined with chess.js: 5000, 5001, 5002
+To be specific, chessboard.js does not understand anything about how the game of
+chess is played: how a knight moves, whose turn is it, is White in check?, etc.
 
-Please see the powerful [chess.js] library for an API to deal with these sorts
-of questions.
+Fortunately, the [chess.js] library deals with exactly this sort of problem and
+plays nicely with chessboard.js's flexible API. Some examples of chessboard.js
+combined with chess.js: [Example 5000], [Example 5001], [Example 5002]
 
+## Docs and Examples
 
-This logic is distinct from the logic of the board. Please see the powerful
-[chess.js] library for this aspect of your application.
-
-
-
-Here is a list of things that chessboard.js is **not**:
-
-- A chess engine
-- A legal move validator
-- A PGN parser
+- Docs - <https://chessboardjs.com/docs>
+- Examples - <https://chessboardjs.com/examples>
 
-chessboard.js is designed to work well with any of those things, but the idea
-behind chessboard.js is that the logic that controls the board should be
-independent of those other problems.
+## Developer Tools
 
-## Docs and Examples
+```sh
+# create a build in the build/ directory
+npm run build
 
-- Docs - <http://chessboardjs.com/docs>
-- Examples - <http://chessboardjs.com/examples>
+# re-build the website
+npm run website
+```
 
 ## License
 
-chessboard.js is released under the terms of the [MIT License].
+[MIT License](LICENSE.md)
 
 [jQuery]:https://jquery.com/
-[chessboardjs.com]:http://chessboardjs.com
+[chessboardjs.com]:https://chessboardjs.com
 [chess.js]:https://github.com/jhlywa/chess.js
-[Example 5000]:http://chessboardjs.com/examples#5000
-[MIT License]:LICENSE.md
+[Example 5000]:https://chessboardjs.com/examples#5000
+[Example 5001]:https://chessboardjs.com/examples#5001
+[Example 5002]:https://chessboardjs.com/examples#5002

examples/1004-multiple-boards.example

@@ -7,7 +7,14 @@ Multiple Boards
 ===== Description
 You can have multiple boards on the same page.
 
-===== HTML
+===== CSS
+.small-board {
+  display: inline-block;
+  margin-right: 5px;
+  width: 200px;
+}
+
+===== HTML
 <div id="board1" class="small-board"></div>
 <div id="board2" class="small-board"></div>
 <div id="board3" class="small-board"></div>

src/chessboard.css → lib/chessboard.css

@@ -1,12 +1,4 @@
-/*!
- * chessboard.js $version$
- *
- * Copyright 2013 Chris Oakman
- * Released under the MIT license
- * https://github.com/oakmac/chessboardjs/blob/master/LICENSE
- *
- * Date: $date$
- */
+/*! chessboard.js v@VERSION | (c) 2019 Chris Oakman | MIT License chessboardjs.com/license */
 
 .clearfix-7da63 {
   clear: both;

src/chessboard.js → lib/chessboard.js

@@ -1,7 +1,7 @@
 // chessboard.js v@VERSION
 // https://github.com/oakmac/chessboardjs/
 //
-// Copyright (c) 2017, Chris Oakman
+// Copyright (c) 2019, Chris Oakman
 // Released under the MIT license
 // https://github.com/oakmac/chessboardjs/blob/master/LICENSE.md
 
@@ -405,22 +405,22 @@
 
   function squeezeFenEmptySquares (fen) {
     return fen.replace(/11111111/g, '8')
-              .replace(/1111111/g, '7')
-              .replace(/111111/g, '6')
-              .replace(/11111/g, '5')
-              .replace(/1111/g, '4')
-              .replace(/111/g, '3')
-              .replace(/11/g, '2')
+      .replace(/1111111/g, '7')
+      .replace(/111111/g, '6')
+      .replace(/11111/g, '5')
+      .replace(/1111/g, '4')
+      .replace(/111/g, '3')
+      .replace(/11/g, '2')
   }
 
   function expandFenEmptySquares (fen) {
     return fen.replace(/8/g, '11111111')
-              .replace(/7/g, '1111111')
-              .replace(/6/g, '111111')
-              .replace(/5/g, '11111')
-              .replace(/4/g, '1111')
-              .replace(/3/g, '111')
-              .replace(/2/g, '11')
+      .replace(/7/g, '1111111')
+      .replace(/6/g, '111111')
+      .replace(/5/g, '11111')
+      .replace(/4/g, '1111')
+      .replace(/3/g, '111')
+      .replace(/2/g, '11')
   }
 
   // returns the distance between two squares
@@ -686,30 +686,30 @@
     // -------------------------------------------------------------------------
 
     function error (code, msg, obj) {
-        // do nothing if showErrors is not set
+      // do nothing if showErrors is not set
       if (
-          config.hasOwnProperty('showErrors') !== true ||
+        config.hasOwnProperty('showErrors') !== true ||
           config.showErrors === false
-        ) {
+      ) {
         return
       }
 
       var errorText = 'Chessboard Error ' + code + ': ' + msg
 
-        // print to console
+      // print to console
       if (
-          config.showErrors === 'console' &&
+        config.showErrors === 'console' &&
           typeof console === 'object' &&
           typeof console.log === 'function'
-        ) {
+      ) {
         console.log(errorText)
         if (arguments.length >= 2) {
           console.log(obj)
         }
         return
       }
 
-        // alert errors
+      // alert errors
       if (config.showErrors === 'alert') {
         if (obj) {
           errorText += '\n\n' + JSON.stringify(obj)
@@ -737,10 +737,10 @@
           currentPosition = deepCopy(config.position)
         } else {
           error(
-              7263,
-              'Invalid value passed to config.position.',
-              config.position
-            )
+            7263,
+            'Invalid value passed to config.position.',
+            config.position
+          )
         }
       }
     }
@@ -1202,11 +1202,11 @@
         // run their onSnapbackEnd function
         if (isFunction(config.onSnapbackEnd)) {
           config.onSnapbackEnd(
-              draggedPiece,
-              draggedPieceSource,
-              deepCopy(currentPosition),
-              currentOrientation
-            )
+            draggedPiece,
+            draggedPieceSource,
+            deepCopy(currentPosition),
+            currentOrientation
+          )
         }
       }
 
@@ -1342,13 +1342,13 @@
       // run onDragMove
       if (isFunction(config.onDragMove)) {
         config.onDragMove(
-            location,
-            draggedPieceLocation,
-            draggedPieceSource,
-            draggedPiece,
-            deepCopy(currentPosition),
-            currentOrientation
-          )
+          location,
+          draggedPieceLocation,
+          draggedPieceSource,
+          draggedPiece,
+          deepCopy(currentPosition),
+          currentOrientation
+        )
       }
 
       // update state
@@ -1395,13 +1395,13 @@
         var oldPosition = deepCopy(currentPosition)
 
         var result = config.onDrop(
-            draggedPieceSource,
-            location,
-            draggedPiece,
-            newPosition,
-            oldPosition,
-            currentOrientation
-          )
+          draggedPieceSource,
+          location,
+          draggedPiece,
+          newPosition,
+          oldPosition,
+          currentOrientation
+        )
         if (result === 'snapback' || result === 'trash') {
           action = result
         }
@@ -1589,7 +1589,7 @@
     }
 
     function mousedownSquare (evt) {
-       // do nothing if we're not draggable
+      // do nothing if we're not draggable
       if (!config.draggable) return
 
       // do nothing if there is no piece on this square
@@ -1611,11 +1611,11 @@
 
       e = e.originalEvent
       beginDraggingPiece(
-          square,
-          currentPosition[square],
-          e.changedTouches[0].pageX,
-          e.changedTouches[0].pageY
-        )
+        square,
+        currentPosition[square],
+        e.changedTouches[0].pageX,
+        e.changedTouches[0].pageY
+      )
     }
 
     function mousedownSparePiece (evt) {
@@ -1635,11 +1635,11 @@
 
       e = e.originalEvent
       beginDraggingPiece(
-          'spare',
-          piece,
-          e.changedTouches[0].pageX,
-          e.changedTouches[0].pageY
-        )
+        'spare',
+        piece,
+        e.changedTouches[0].pageX,
+        e.changedTouches[0].pageY
+      )
     }
 
     function mousemoveWindow (evt) {
@@ -1658,7 +1658,7 @@
       evt.preventDefault()
 
       updateDraggedPiece(evt.originalEvent.changedTouches[0].pageX,
-                         evt.originalEvent.changedTouches[0].pageY)
+        evt.originalEvent.changedTouches[0].pageY)
     }
 
     var throttledTouchmoveWindow = throttle(touchmoveWindow, config.dragThrottleRate)
@@ -1679,7 +1679,7 @@
 
       // get the location
       var location = isXYOnSquare(evt.originalEvent.changedTouches[0].pageX,
-                                  evt.originalEvent.changedTouches[0].pageY)
+        evt.originalEvent.changedTouches[0].pageY)
 
       stopDraggedPiece(location)
     }
@@ -1815,3 +1815,9 @@
   window['Chessboard']['fenToObj'] = fenToObj
   window['Chessboard']['objToFen'] = objToFen
 })() // end anonymous wrapper
+
+/* export Chessboard object if using node or any other CommonJS compatible
+ * environment */
+if (typeof exports !== 'undefined') {
+  exports.Chessboard = window.Chessboard
+}