release verion for 1.0

README.md

@@ -0,0 +1,44 @@
+# ArchaeoDate
+
+ArchaeoDate is a CLI for easily converting between the two commonly used archaeological date formats, BP (before present) and BC/AD. 
+
+## Installation
+
+Archaeodate is provided as a executable file to be run from the terminal. Simply download the correct file for you system and run the file.
+
+For easy of use you may wish to create an alias to the location of the file.
+
+## Useage
+
+There are two components to any date: a number and a date system.
+
+For example, 2000 BC has the number 2000 and the system BC, which stands for Before Christ.
+
+To convert between BP and BC/AD enter a number into the number entry field and the two letter abbreviation of the system into the system field. The abbreviations are not case sensative.
+
+CE and BCE are also suported, however the output will allways be in BC/AD.
+
+## Licence
+
+MIT License
+
+Copyright (c) 2024 Joshua Samuel Miller
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+