Add orcid notes to readme and add changelog notes.

CHANGELOG.md

@@ -4,6 +4,9 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.3.0] - 2023-02-15
+- Add ORCID ID integration.
+
 ## [1.2.0] - 2023-02-01
 - Reorganize code.
 

README.md

@@ -3,25 +3,28 @@ Code Repository: https://github.com/gsu-library/datacite-bulk-doi-creator-webapp
 Author: Matt Brooks <[email protected]>  
 Date Created: 2022-06-29  
 License: [GPL3](LICENSE)  
-Version: 1.2.0
+Version: 1.3.0
 
 ## Description
 A PHP WebApp that bulk creates DataCite DOIs from a provided CSV file. DOIs are created in the findable state. If you are looking for the python version of this WebApp see [DataCite Bulk DOI Creator](https://github.com/gsu-library/datacite-bulk-doi-creator).
 
 For more information about DOIs please see DataCite's [support page](https://support.datacite.org/) and/or resources from their [homepage](https://doi.datacite.org/). Information on their [metadata schemas](https://schema.datacite.org/) is also available.
 
 ## Setup
-Put the repository files in a folder that is within Apache's webroot.
+Put the repository files in a folder that is within your web server's webroot.
 
-### Configuration
+### General Configuration
 Rename config/config.sample.php to config/config.php and fill in your DOI prefix, username (repository ID), and password. If wanting to test the script out with the test DataCite API replace the URL with the test API URL (https://api.test.datacite.org/dois) and credentials. There are other configuration options that can be adjusted if wanted.
 
-TODO: add info on orcid integration
-
 **It is important that the config folder and its contents are not readable from a web browser. If not using Apache, the config/.htaccess file should be replaced with something denying web access to the contents of the folder.**
 
 PHP will also need read/write access to both the reports and uploads folders. Make sure owner/group permissions are set accordingly.
 
+### ORCID Configuration
+Create an [ORCID](https://orcid.org) account, [register a public API client](https://info.orcid.org/documentation/integration-guide/registering-a-public-api-client/), and set the client ID and secret in the configuration file. The token and API URLs can be adjusted if sandbox testing is wanted.
+
+**The config folder will need to be writable by PHP to save the ORCID acess token.**
+
 ### Authentication
 Currently this application uses basic authentication provided by Apache (see [Apache AuthType directive](https://httpd.apache.org/docs/2.4/mod/mod_authn_core.html#authtype)). To use basic authentication [create a .htpasswd file](https://httpd.apache.org/docs/2.4/programs/htpasswd.html) within the config directory, rename .htaccess.sample to .htaccess in the root folder, and set the AuthUserFile directive to the absolute path of the .htpasswd file. The .htpasswd file does not have to live in the config folder, but wherever it lives should not be accessible from the web.
 
@@ -36,6 +39,7 @@ type - resource type
 description - abstract description  
 publisher - publisher  
 source_url - URL reference to resource  
+oricd - ORCID ID (not required, replaces creator fields when configured and present)  
 creator{n} - full creator name (header example: creator1, creator2, etc.)  
 creator{n}_type - Personal or Organizational (not required, defaults to Personal)  
 creator{n}_given - creator given name