From 25bb829ccbbb3fea2dc1859ea66d020f8e32d909 Mon Sep 17 00:00:00 2001
From: Tristan Ancelet <tristan.ancelet@acumera.com>
Date: Sat, 18 May 2024 13:28:12 -0500
Subject: [PATCH] Added gitignore & readme

---
 .gitignore |  4 ++++
 README.md  | 15 +++++++++++++++
 2 files changed, 19 insertions(+)
 create mode 100644 .gitignore
 create mode 100644 README.md

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..dcd64c2
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,4 @@
+*
+!.gitignore
+!log-search
+!README.md
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..145719c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# log-search
+This is a bash utility for getting & parsing logs from both local & remote sources.
+
+
+## Nodes (Local & Remote)
+On nodes themselves the utility allows you to grab logs from two different sources:
+- Journal
+- Messages file
+
+### Journal
+On nodes themselves the utility can grab logs from both the journal & messages files.
+
+## Syslog Server
+### Syslog Node Logs
+If you use a syslog server you can also remotely query logs from the log directories.