Update docs

element-hq · Jul 14, 2023 · 0bd018d · 0bd018d
1 parent 42770be
commit 0bd018d
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 20 deletions.
diff --git a/FORKING.md b/FORKING.md
diff --git a/README.md b/README.md
@@ -31,10 +31,6 @@ Please see our [contribution guide](CONTRIBUTING.md).
 
 Come chat with the community in the dedicated Matrix [room](https://matrix.to/#/#element-x-ios:matrix.org).
 
-## Forking
-
-Please read our [forking guide](FORKING.md).
-
 ## Build instructions
 
 Please refer to the [setting up a development environment](CONTRIBUTING.md#setting-up-a-development-environment) section from the [contribution guide](CONTRIBUTING.md).
@@ -45,6 +41,10 @@ When you are experiencing an issue on ElementX iOS, please first search in [GitH
 and then in [#element-x-ios:matrix.org](https://matrix.to/#/#element-x-ios:matrix.org).
 If after your research you still have a question, ask at [#element-x-ios:matrix.org](https://matrix.to/#/#element-x-ios:matrix.org). Otherwise feel free to create a GitHub issue if you encounter a bug or a crash, by explaining clearly in detail what happened. You can also perform bug reporting (Rageshake) from the Element application by shaking your phone or going to the application settings. This is especially recommended when you encounter a crash.
 
+## Forking
+
+Please read our [forking guide](docs/FORKING.md).
+
 ## Copyright & License
 
 Copyright (c) 2022 New Vector Ltd

diff --git a/docs/FORKING.md b/docs/FORKING.md
@@ -0,0 +1,32 @@
+# Forking
+
+### Update the bundle identifier / app display name
+
+To change the bundle identifier and the app display name for your app, open the `project.yml` file in the project root folder and change these settings:
+
+```
+BASE_BUNDLE_IDENTIFIER: io.element.elementx
+APP_DISPLAY_NAME: Element X
+```
+
+After the changes run `xcodegen` to propagate them.
+
+### Setup the location sharing
+
+The location sharing feature on Element X is currently integrated with [MapLibre](https://maplibre.org).
+
+The MapLibre SDK requires an API key to work, so you need to get one for yourself. 
+
+After you get an API key, you need to configure the project by adding it inside the file `secrets.xconfig` in the project root folder. After you are done, the file should contain a setting like this:
+
+```
+MAPLIBRE_API_KEY = your_map_libre_key
+```
+
+It’s not recommended to push your API key in your repository since other people may get it. 
+
+One way to avoid pushing the API key by mistake is running on your machine the command: 
+```
+git update-index assume-unchanged secrets.xcconfig
+``` 
+this will prevent pushing any update of the file`secrets.xcconfig`.