Decadent and symmetrical

[musicbrainz.git] / listenbrainz.el

diff --git a/listenbrainz.el b/listenbrainz.el
index 02295510799734814ec4c8aa34e704b13c9fc356..fc32c666c931b8804085364ca8e28330a3efeaa2 100644 (file)
--- a/listenbrainz.el
+++ b/listenbrainz.el
@@ -27,10 +27,19 @@
 
 ;;; Commentary:
 
 
 ;;; Commentary:
 

-;; - listen & submit metadata to ListenBrainz
-;; - partial & incomplete
-;; - no error checks
-;; - sync -> async
+;; An interface to ListenBrainz, a project to store a record of the music that
+;; you listen to. The listening data, can be used to provide statistics,
+;; recommendations and general exploration.
+;;
+;; The package can be used programmatically (e.g. from a music player) to auto
+;; submit listening data `listenbrainz-submit-listen'. There are other entrypoints
+;; for reading user stats such as `listenbrainz-stats-artists' or
+;; `listenbrainz-listens'.
+;;
+;; Some API calls require a user token, which can be found in your ListenBrainz
+;; profile. Configure, set or `customize' the `listenbrainz-api-token' as needed.
+;;
+;; https://listenbrainz.readthedocs.io/

 
 
 ;;; Code:
 
 
 ;;; Code:


@@ -104,7 +113,6 @@ All timestamps used in ListenBrainz are UNIX epoch timestamps in UTC."
 ;;
 ;;;; ; ;; ;
 
 ;;
 ;;;; ; ;; ;
 

-

 (defmacro listenbrainz--deformatter (name format-string format-args alist)
   "Generate function with NAME to format data returned from an API call.
 The function has the name `listenbrainz--format-NAME`.
 (defmacro listenbrainz--deformatter (name format-string format-args alist)
   "Generate function with NAME to format data returned from an API call.
 The function has the name `listenbrainz--format-NAME`.


@@ -216,7 +224,6 @@ macroexpands to something like ->
 ;;
 ;;; ; ;; ; ;   ;
 
 ;;
 ;;; ; ;; ; ;   ;
 

-;;;###autoload

 (defun listenbrainz-validate-token (token)
   "Check if TOKEN is valid. Return a username or nil."
   (message "listenbrainz: checking token %s" token)
 (defun listenbrainz-validate-token (token)
   "Check if TOKEN is valid. Return a username or nil."
   (message "listenbrainz: checking token %s" token)