From e9cf9155d671652df75aa28ac9117deb86ab4605 Mon Sep 17 00:00:00 2001 From: "Aaron L. Zeng" Date: Mon, 25 Dec 2023 01:30:47 -0500 Subject: [PATCH] Update advent-of-code.el commentary --- elisp/advent-of-code.el | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/elisp/advent-of-code.el b/elisp/advent-of-code.el index 20346d4..2336fa8 100644 --- a/elisp/advent-of-code.el +++ b/elisp/advent-of-code.el @@ -1,7 +1,7 @@ ;;; advent-of-code.el --- Useful shortcuts for Advent of Code -*- lexical-binding: t; -*- ;; ;; Version: 0.1.0 -;; Homepage: https://github.com/bcc32/advent-of-code.el +;; Homepage: https://github.com/bcc32/advent-of-code ;; Package-Requires: ((emacs "25.1") (request "0.3.0")) ;; ;;; Commentary: @@ -23,6 +23,21 @@ ;; Before using this package, you must customize `advent-of-code-cookie-jar' and ;; `advent-of-code-email'. ;; +;; This script/repo/tool does follow the automation guidelines on the +;; /r/adventofcode community wiki +;; (https://www.reddit.com/r/adventofcode/wiki/faqs/automation). Specifically: +;; +;; - The User-Agent header in `advent-of-code--request' includes both the +;; maintainer of this Emacs package and the invoking user's (self-reported) +;; email. +;; +;; - User inputs can only be requested manually by pressing C-c C-c in an input +;; file's buffer. +;; +;; - Currently, outbound requests are not throttled because they can only be +;; initiated manually by the user, and only one at a time (no commands to, e.g., +;; bulk-download inputs). +;; ;;; Code: (require 'request)