README tweaks, add agpl-3

Author: coatless

README.Rmd

@@ -21,6 +21,17 @@ knitr::opts_chunk$set(
 
 `filestamp` makes it easy to add and maintain consistent headers across all files in your project, regardless of programming language. Headers can include copyright notices, file descriptions, authorship information, and other metadata.
 
+### What are file headers?
+
+File headers are structured comments at the beginning of code files that contain important metadata. For example, a header might include:
+
+```r
+# Copyright (c) Acme Corp 2025
+# Author: Jane Developer
+# License: MIT
+# Last updated: 2025-04-21
+```
+
 ## Installation
 
 You can install the development version of `filestamp` from [GitHub][filestamp-gh] with:
@@ -95,6 +106,7 @@ The package comes with several built-in templates:
 - `default` - A simple header with copyright, author, and license information
 - `mit` - MIT License header
 - `gpl-3` - GNU General Public License header
+- `agpl-3` - GNU Affero General Public License header
 
 List available templates:
 
@@ -156,15 +168,21 @@ stamp_update("collaborative_script.R", list(
 
 ## Language Support
 
-The package supports many programming languages out of the box:
+`filestamp` supports 15+ programming languages out of the box:
 
 ```{r}
-#| label: language-supported
+#| label: languages
 #| eval: false
-# List supported languages
+# List all supported languages
 languages()
+```
 
-# Register a custom language
+Add support for additional languages:
+
+```{r}
+#| label: custom-language
+#| eval: false
+# Register a new language
 language_register(
   "kotlin",
   extensions = c("kt", "kts"),
@@ -176,7 +194,7 @@ language_register(
 
 ## Variables
 
-You can use variables in your templates to customize the header content. The package provides several built-in variables, and you can also define your own.
+Customize your headers with built-in and custom variables:
 
 ```{r}
 #| label: stamp-template-variables
@@ -187,10 +205,20 @@ stamp_variables_list()
 # Add a custom variable
 stamp_variables_add("team", "Data Science")
 
-# Set company name
+# Set company name globally
 options(filestamp.company = "Acme Corp")
 ```
 
+Built-in variables include:
+
+- `{{year}}` - Current year
+- `{{date}}` - Current date (YYYY-MM-DD)
+- `{{date_full}}` - Full timestamp
+- `{{user}}` - Current username
+- `{{company}}` - Company name from options
+- `{{filename}}` - Current file name
+- `{{file_ext}}` - File extension
+
 ## License
 
 AGPL (>= 3)

README.md

@@ -13,6 +13,18 @@ all files in your project, regardless of programming language. Headers
 can include copyright notices, file descriptions, authorship
 information, and other metadata.
 
+### What are file headers?
+
+File headers are structured comments at the beginning of code files that
+contain important metadata. For example, a header might include:
+
+``` r
+# Copyright (c) Acme Corp 2025
+# Author: Jane Developer
+# License: MIT
+# Last updated: 2025-04-21
+```
+
 ## Installation
 
 You can install the development version of `filestamp` from
@@ -88,6 +100,7 @@ The package comes with several built-in templates:
   information
 - `mit` - MIT License header
 - `gpl-3` - GNU General Public License header
+- `agpl-3` - GNU Affero General Public License header
 
 List available templates:
 
@@ -149,13 +162,17 @@ stamp_update("collaborative_script.R", list(
 
 ## Language Support
 
-The package supports many programming languages out of the box:
+`filestamp` supports 15+ programming languages out of the box:
 
 ``` r
-# List supported languages
+# List all supported languages
 languages()
+```
+
+Add support for additional languages:
 
-# Register a custom language
+``` r
+# Register a new language
 language_register(
   "kotlin",
   extensions = c("kt", "kts"),
@@ -167,9 +184,7 @@ language_register(
 
 ## Variables
 
-You can use variables in your templates to customize the header content.
-The package provides several built-in variables, and you can also define
-your own.
+Customize your headers with built-in and custom variables:
 
 ``` r
 # List available variables
@@ -178,10 +193,20 @@ stamp_variables_list()
 # Add a custom variable
 stamp_variables_add("team", "Data Science")
 
-# Set company name
+# Set company name globally
 options(filestamp.company = "Acme Corp")
 ```
 
+Built-in variables include:
+
+- `{{year}}` - Current year
+- `{{date}}` - Current date (YYYY-MM-DD)
+- `{{date_full}}` - Full timestamp
+- `{{user}}` - Current username
+- `{{company}}` - Company name from options
+- `{{filename}}` - Current file name
+- `{{file_ext}}` - File extension
+
 ## License
 
 AGPL (\>= 3)

inst/templates/agpl-3.yml

@@ -0,0 +1,25 @@
+name: agpl-3
+fields:
+  - name: copyright
+    default: "{{company}} {{year}}"
+    required: true
+  - name: author
+    default: "{{user}}"
+    required: true
+content: |
+  Copyright (c) {{copyright}}
+  Author: {{author}}
+  License: GNU Affero General Public License v3.0 or later
+
+  This program is free software: you can redistribute it and/or modify
+  it under the terms of the GNU Affero General Public License as published
+  by the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  This program is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU Affero General Public License for more details.
+
+  You should have received a copy of the GNU Affero General Public License
+  along with this program.  If not, see <https://www.gnu.org/licenses/>.