Updated docs

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-22 Ionică Bizău <bizauionica@gmail.com> (https://ionicabizau.net)
+Copyright (c) 2015-23 Ionică Bizău <bizauionica@gmail.com> (https://ionicabizau.net)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -206,7 +206,7 @@ module.exports = {
     // The file where the commit hashes will be stored
   , "path": "~/.git-stats"
 
-    // First day of the week
+    // [DEPRECATED] First day of the week https://github.com/IonicaBizau/git-stats/issues/121
   , first_day: "Sun"
 
     // This defaults to *one year ago*

lib/index.js

@@ -469,7 +469,7 @@ class GitStats {
                     theme: options.theme
                   , start: options.start
                   , end: options.end
-                  , firstDay: options.firstDay
+                  , firstDay: options.firstDay // [DEPRECATED] https://github.com/IonicaBizau/git-stats/issues/121
                   , cal: cal
                   , raw: options.raw
                 }
@@ -661,6 +661,7 @@ GitStats.DEFAULT_CONFIG = {
     // This defaults in library
   , path: undefined
 
+    // [DEPRECATED] https://github.com/IonicaBizau/git-stats/issues/121
     // This defaults in cli-gh-cal
   , first_day: undefined
 

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "git-stats",
-  "version": "3.1.1",
+  "version": "3.1.2",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "git-stats",
-      "version": "3.1.1",
+      "version": "3.1.2",
       "hasInstallScript": true,
       "license": "MIT",
       "dependencies": {

package.json

@@ -3,7 +3,7 @@
     "git-stats": "bin/git-stats"
   },
   "name": "git-stats",
-  "version": "3.1.1",
+  "version": "3.1.2",
   "description": "Local git statistics including GitHub-like contributions calendars.",
   "main": "lib/index.js",
   "scripts": {
@@ -192,7 +192,7 @@
             "    // The file where the commit hashes will be stored",
             "  , \"path\": \"~/.git-stats\"",
             "",
-            "    // First day of the week",
+            "    // [DEPRECATED] First day of the week https://github.com/IonicaBizau/git-stats/issues/121",
             "  , first_day: \"Sun\"",
             "",
             "    // This defaults to *one year ago*",
@@ -286,4 +286,4 @@
     "bloggify.json",
     "bloggify/"
   ]
-}
+}