From ee09cabd5a5dce3e75c82e24f0c4cd4e40989eee Mon Sep 17 00:00:00 2001
From: Alis Akers <alismxwll@gmail.com>
Date: Fri, 31 Jan 2025 11:45:48 -0800
Subject: [PATCH] feat: Add README, update file naming and references

This commit introduces a new README.md file with basic project information and placeholders for future sections. It also renames 'code-of-conduct.md' to 'CODE_OF_CONDUCT.md' for consistency. All references to the code of conduct within markdown files have been updated to reflect the name change. Additionally, it sets up a placeholder file for codeowners.
---
 CODEOWNERS.md                            |  1 +
 code-of-conduct.md => CODE_OF_CONDUCT.md |  0
 CONTRIBUTING.md                          |  2 +-
 README.md                                | 29 ++++++++++++++++++++++++
 4 files changed, 31 insertions(+), 1 deletion(-)
 create mode 100644 CODEOWNERS.md
 rename code-of-conduct.md => CODE_OF_CONDUCT.md (100%)
 create mode 100644 README.md

diff --git a/CODEOWNERS.md b/CODEOWNERS.md
new file mode 100644
index 0000000..0f51830
--- /dev/null
+++ b/CODEOWNERS.md
@@ -0,0 +1 @@
+# Placeholder for future codeowners
diff --git a/code-of-conduct.md b/CODE_OF_CONDUCT.md
similarity index 100%
rename from code-of-conduct.md
rename to CODE_OF_CONDUCT.md
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 76ff7bd..10be28e 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -6,7 +6,7 @@ collaborative environment.
 
 Before contributing, we encourage you to also read our [LICENSE](LICENSE),
 [README](README.md), and
-[code-of-conduct](code-of-conduct.md)
+[code-of-conduct](CODE_OF_CONDUCT.md)
 files, also found in this repository. If you have any inquiries or questions not
 answered by the content of this repository, feel free to [contact us](mailto:dibbs@cdc.gov).
 
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5a870bd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# DIBBS VM
+
+## Table of Contents
+- [DIBBS VM](#dibbs-vm)
+  - [Table of Contents](#table-of-contents)
+  - [Overview](#overview)
+  - [Searchable Documentation](#searchable-documentation)
+  - [Getting Started](#getting-started)
+  - [Code of Conduct](#code-of-conduct)
+  - [Contributing](#contributing)
+  - [License](#license)
+
+## Overview
+DIBBS (Data Ingestion Building Blocks) VM (Virtual Machine) is a project that aims to provide a VM that can be used to run the DIBBS software stacks.
+
+## Searchable Documentation
+_Coming soon!_
+
+## Getting Started
+_Also coming soon!_
+
+## Code of Conduct
+Please refer to our [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) for more information on how we conduct ourselves in this project.
+
+## Contributing
+To contribute, refer to our [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## License
+[License](LICENSE)