From 4fff23e2ff6d052ad913e15fd505d942429df110 Mon Sep 17 00:00:00 2001
From: astatine <astatine@fivem.net>
Date: Tue, 10 Dec 2019 09:56:20 +0100
Subject: [PATCH] readme, .gitignore update, resources/local dir

---
 .gitignore                 |  4 +---
 README.md                  | 31 +++++++++++++++++++++++++++++++
 resources/[local]/.gitkeep |  0
 3 files changed, 32 insertions(+), 3 deletions(-)
 create mode 100644 README.md
 create mode 100644 resources/[local]/.gitkeep

diff --git a/.gitignore b/.gitignore
index c956802..07b5567 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,5 +1,3 @@
-CitizenMP.Server.exe
-CitizenMP.Server.exe.config
-NLog.config
+*.cfg
 /cache/
 /resources/\[local\]/
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..075f067
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# cfx-server-data
+_The data repository for Cfx.re servers_
+
+## Usage
+1. Make sure to `git clone`. Don't "Download ZIP", as that'll make it _much_ harder to update to newer versions.
+2. Put custom resources in `resources/[local]/` if you don't want to be affected by any random messups.
+
+### Advanced usage
+You can also consider using the repository as a submodule + symlink for your own Git repository:
+
+**Linux**:
+```
+$ git submodule add https://github.com/citizenfx/cfx-server-data.git vendor/server-data
+$ ln -s vendor/server-data/resources/ 'resources/[base]/'
+```
+
+**Windows**:
+```
+> git submodule add https://github.com/citizenfx/cfx-server-data.git vendor/server-data
+> mklink /d resources\[base] vendor\server-data\resources
+```
+
+## Policy
+You can make pull requests to propose changes that benefit _everyone_. Add new useful resources, change/improve
+existing ones - anything goes, as long as you make sure to:
+
+1. Not break existing users/APIs.
+2. Not change default behavior without a toggle.
+3. Use best practices (convars over config files, native commands wherever possible, etc.)
+
+Modifying or rewriting existing resources in this repository for local use only is _strongly_ discouraged.
\ No newline at end of file
diff --git a/resources/[local]/.gitkeep b/resources/[local]/.gitkeep
new file mode 100644
index 0000000..e69de29