From a42458326da6349064feed33fef53917aa95196d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jos=C3=A9=20Luis=20Pereira?= <pepelui@outlook.com>
Date: Thu, 8 Sep 2022 10:25:43 -0300
Subject: [PATCH] Update README

---
 README.md | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7c059d1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# TaxonPages
+TaxonPages is a tool to serve taxon pages for TaxonWorks projects.
+
+## Usage
+
+1. Click on "Fork" button to create your own repository from this.
+2. Uncheck `Copy the setup branch only`
+
+### Setup
+
+1. Switch to `setup` branch in your TaxonPages repository.
+2. We provide some settings by default to setup your public pages, but API parameters are required and must be configured to get the data from your TaxonWorks project.
+
+```yaml
+# config/api.yml
+---
+  url: https://<your.taxonworks.server>/api/v1
+  project_token: yourprojecttoken
+```
+3. Push the changes after update the configuration files inside `setup` branch
+4. GitHub actions will build TaxonPages with the current configuration in `setup` branch and publish it to the `gh-pages` branch
+
+## Customization
+
+### Pages
+
+TaxonPages out of the box support markdown and vue for content sites. Add your content pages inside `pages` folder. By default, TaxonPages use the file name to create the route.
+For example, if the filename is "contributors.md" the route to access it will be http://yourtaxonpagessite/contributors
+
+### Style
+
+If you want to change the color palette, you can edit  `/config/style/theme.css` file, colors must be in RGB format.
+TaxonPages use [TailwindCSS](https://tailwindcss.com/docs/configuration) framework for the style. We already provide default settings for colors and markdown. If you want to make any change to your configuration, you must do so in the `config/vendor/tailwind.config.js` file. This file uses the TaxonPages configuration as a default. It is possible to overwrite it as long as you use it as a preset.
\ No newline at end of file