From 5c3a97ea8c1dd55db8adae5e4f24b8ab9c348d8c Mon Sep 17 00:00:00 2001
From: mjanez <96422458+mjanez@users.noreply.github.com>
Date: Sat, 22 Apr 2023 21:51:14 +0200
Subject: [PATCH] Add README.md to log/ and metadata/

---
 .gitignore         | 6 ++++--
 log/README.md      | 2 ++
 metadata/README.md | 5 +++++
 3 files changed, 11 insertions(+), 2 deletions(-)
 create mode 100644 log/README.md
 create mode 100644 metadata/README.md

diff --git a/.gitignore b/.gitignore
index 80fd0ee..2c7c45a 100644
--- a/.gitignore
+++ b/.gitignore
@@ -9,8 +9,10 @@ _src/*
 local/*
 .vscode
 __pycache__
-log
-metadata
+log/*
+!log/README.md
+metadata/*
+!metadata/README.md
 
 # environment
 .env
\ No newline at end of file
diff --git a/log/README.md b/log/README.md
new file mode 100644
index 0000000..80d84d5
--- /dev/null
+++ b/log/README.md
@@ -0,0 +1,2 @@
+# Log folder
+This folder is used to store logs generated by `ckan2pycsw` script.
\ No newline at end of file
diff --git a/metadata/README.md b/metadata/README.md
new file mode 100644
index 0000000..85ce6f3
--- /dev/null
+++ b/metadata/README.md
@@ -0,0 +1,5 @@
+# ISO19139 Metadata files
+This folder is used to store ISO19139 metadata files (`XML`).
+
+## Usage
+`ckan2pycsw` save your ISO19139 metadata files in this folder by identifier as filename. Each file should correspond to a dataset and its distributions (resources).
\ No newline at end of file