align the namespace with other Liturgical Calendar projects

README.md

@@ -9,21 +9,58 @@ The API takes the following parameters:
 * **`YEAR`**: the year for which anniversaries will be calculated. For example, if Saint Ignatius was canonized in 1622, and the value `2022` is supplied to the **`YEAR`** parameter, then a `CENTENARY` anniversary of 400 years will be returned.
 * **`LOCALE`**: the language in which strings should be translated / localized.
 
-# Development
+## Installation
 
-To test the API locally, simply launch using PHP's built-in server: `php -S localhost:8000`. You can choose to serve over a different port if you wish.
+### Composer *(recommended)*
 
-# Locales
 
-In order to obtain localized results in development, you must have the correct locales installed on your local machine.
+In your project directory issue `composer require liturgical-calendar/anniversarycalculator`. The package will be installed to the `vendor` folder and the requirement added to your `composer.json`.
 
-Run `locale -a` and check to see if <kbd>de_DE.utf8</kbd>, <kbd>es_ES.utf8</kbd>, <kbd>fr_FR.utf8</kbd>, <kbd>it_IT.utf8</kbd>, <kbd>nl_NL.utf8</kbd>, <kbd>pt_PT.utf8</kbd> are among the results.
+### Git
 
-For any locales that are not installed, you will not get translation results for certain strings.
+You can also clone the repository to your project folder (useful mostly for development of the API and contributing to the codebase):
 
-In order to install a locale on Ubuntu, run `sudo apt-get install language-pack-{two-letter-iso-code}`. For example `sudo apt-get install language-pack-es` will install the Spanish locale on your machine. You will then be able to get translation results for Spanish.
+```console
+git clone https://github.com/Liturgical-Calendar/LitCalAnniversaryCalculator.git .
+composer install
+```
 
-# Translation into other languages
+This will clone the repository into the current folder rather than to a folder with the same name as the repository, and then install the package for inclusion in your scripts.
+
+A sample `index.php` script is included.
+
+## Usage
+
+If you installed the package via git, you should already have a sample `index.php` file.
+
+If you installed the package via composer, create a script similar to the following:
+
+```php
+// index.php
+<?php
+
+use LiturgicalCalendar\AnniversaryCalculator;
+
+require_once 'vendor/autoload.php';
+
+$calculator = new AnniversaryCalculator();
+$calculator->init();
+```
+
+Then to test the API locally simply launch using PHP's built-in server: `php -S localhost:8000`. You can choose to serve over a different port if you wish.
+
+Now open **localhost:8000** in your browser. You should see a JSON response. You can change the year and the locale using the `YEAR` and `LOCALE` query parameters.
+
+> [!NOTE]
+> In order to obtain localized results, you must have the correct locales installed.
+>
+> Run `locale -a` and check to see if <kbd>de_DE.utf8</kbd>, <kbd>es_ES.utf8</kbd>, <kbd>fr_FR.utf8</kbd>, <kbd>it_IT.utf8</kbd>, <kbd>nl_NL.utf8</kbd>, <kbd>pt_PT.utf8</kbd> are among the results.
+>
+> For any locales that are not installed, you will not get translation results for certain strings.
+>
+> In order to install a locale on Ubuntu, run `sudo apt-get install language-pack-{two-letter-iso-code}`. For example `sudo apt-get install language-pack-es` will install the Spanish locale on your machine. You will then be able to get translation results for Spanish.
+
+## Translation into other languages
 
 <a href="https://translate.johnromanodorazio.com/engage/liturgical-calendar/">
 <img src="https://translate.johnromanodorazio.com/widgets/liturgical-calendar/-/liturgical-anniversary-calculator-data/open-graph.png" alt="Translation status" />

composer.json

@@ -1,14 +1,17 @@
 {
-    "name": "litcal/anniversarycalculator",
+    "name": "liturgical-calendar/anniversarycalculator",
     "description": "an API that calculates anniversaries of liturgical recurrences from the General Roman Calendar",
     "type": "library",
     "require-dev": {
         "squizlabs/php_codesniffer": "^3.10"
     },
+    "require": {
+        "php": ">=7.4"
+    },
     "license": "MIT",
     "autoload": {
         "psr-4": {
-            "LitCal\\": "src/"
+            "LiturgicalCalendar\\": "src/"
         },
         "files": ["src/pgettext.php"]
     },
@@ -19,5 +22,6 @@
         }
     ],
     "minimum-stability": "stable",
-    "require": {}
+    "config": {
+    }
 }

index.php

@@ -1,10 +1,7 @@
 <?php
 
-use LitCal\AnniversaryCalculator;
+use LiturgicalCalendar\AnniversaryCalculator;
 
-// error_reporting(E_ALL);
-// ini_set('display_errors', 1);
-ini_set('date.timezone', 'Europe/Vatican');
 require_once 'vendor/autoload.php';
 
 $calculator = new AnniversaryCalculator();

src/AnniversaryCalculator.php

@@ -1,9 +1,9 @@
 <?php
 
-namespace LitCal;
+namespace LiturgicalCalendar;
 
-use LitCal\AnniversaryCalculator\AnniversaryEvent;
-use LitCal\AnniversaryCalculator\Enums\StatusCode;
+use LiturgicalCalendar\AnniversaryCalculator\AnniversaryEvent;
+use LiturgicalCalendar\AnniversaryCalculator\Enums\StatusCode;
 
 class AnniversaryCalculator
 {

src/AnniversaryCalculator/AnniversaryEvent.php

@@ -1,10 +1,10 @@
 <?php
 
-namespace LitCal\AnniversaryCalculator;
+namespace LiturgicalCalendar\AnniversaryCalculator;
 
-use LitCal\AnniversaryCalculator\Enums\AnnivType;
-use LitCal\AnniversaryCalculator\Enums\AreaInterest;
-use LitCal\AnniversaryCalculator\Enums\LitCalendar;
+use LiturgicalCalendar\AnniversaryCalculator\Enums\AnnivType;
+use LiturgicalCalendar\AnniversaryCalculator\Enums\AreaInterest;
+use LiturgicalCalendar\AnniversaryCalculator\Enums\LitCalendar;
 
 class AnniversaryEvent
 {

src/AnniversaryCalculator/Enums/AnnivType.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace LitCal\AnniversaryCalculator\Enums;
+namespace LiturgicalCalendar\AnniversaryCalculator\Enums;
 
 class AnnivType
 {

src/AnniversaryCalculator/Enums/AreaInterest.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace LitCal\AnniversaryCalculator\Enums;
+namespace LiturgicalCalendar\AnniversaryCalculator\Enums;
 
 class AreaInterest
 {

src/AnniversaryCalculator/Enums/LitCalendar.php

@@ -1,12 +1,12 @@
 <?php
 
-namespace LitCal\AnniversaryCalculator\Enums;
+namespace LiturgicalCalendar\AnniversaryCalculator\Enums;
 
 class LitCalendar
 {
     public const UNIVERSAL = "universal";
-    public const NATIONAL = "national";
-    public const DIOCESAN = "diocesan";
+    public const NATIONAL  = "national";
+    public const DIOCESAN  = "diocesan";
     public const WIDE_AREA = "wide_area";
     private array $GTXT;
 

src/AnniversaryCalculator/Enums/StatusCode.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace LitCal\AnniversaryCalculator\Enums;
+namespace LiturgicalCalendar\AnniversaryCalculator\Enums;
 
 class StatusCode
 {