Skip to content

Commit 7672d48

Browse files
Merge pull request #169 from positivecrash/master
Readme edited info about fork & improved markdown
2 parents 1dadbff + 8a8172a commit 7672d48

File tree

1 file changed

+22
-6
lines changed

1 file changed

+22
-6
lines changed

README.md

+22-6
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# sensors.social
22

3+
---
4+
35
## 📌 Overview
46

57
**sensors.social** is a decentralized application that visualizes data from sensors sending their measurements to the blockchain (Polkadot network, Robonomics parachain). The platform supports two modes of operation:
@@ -9,15 +11,18 @@
911

1012
For more details on connectivity and how to deploy your own map interface (or even a connectivity server), visit [Robonomics Academy](https://robonomics.academy/en/learn/sensors-connectivity-course/overview/).
1113

14+
---
15+
1216
## 🚀 Deployment
1317

14-
### 1️⃣ Clone the Repository
18+
This section is intended for contributors working on the existing map and developers setting up their own map interface. For comprehensive instructions on configuring your own user interface, refer to the next sections.
1519

16-
Simply clone the repository and navigate to the project directory:
20+
### 1️⃣ Fork & Clone the Repository
21+
22+
If you plan to contribute or customize the project extensively, consider forking it first. Then clone the repository:
1723

1824
```sh
19-
git clone https://github.com/airalab/sensors.social.git
20-
cd sensors.social
25+
git clone <map repository>
2126
```
2227

2328
If you plan to contribute or customize the project extensively, consider forking it first.
@@ -43,10 +48,15 @@ Then install the required dependencies:
4348
yarn dev
4449
```
4550

51+
---
52+
53+
4654
## 🔧 Setup Your Own Map (For Experienced Users)
4755

4856
### 1️⃣ Deploy Your Own Instance of the Map
4957

58+
Refer to the "🚀 Deployment" section.
59+
5060
### 2️⃣ Enable GitHub Actions
5161

5262
To activate GitHub Actions in your repository:
@@ -109,6 +119,9 @@ After modifying the necessary files, deploy your instance of the map by followin
109119
You can now access your deployed map using the provided GitHub Pages URL.
110120

111121

122+
---
123+
124+
112125
## 💬 Localization & Translations
113126

114127
You can add a new language to the map by modifying the translation files located in `src/translate/`.
@@ -141,7 +154,7 @@ You can add a new language to the map by modifying the translation files located
141154
Measurement values are located in `src/measurements/`.
142155
To support multiple languages, update the relevant files in this folder.
143156

144-
## Files to Update
157+
#### Files to Update
145158

146159
| Measurement Type | File Name |
147160
|-------------------------|-----------|
@@ -156,7 +169,7 @@ You can add a new language to the map by modifying the translation files located
156169
| Pressure | `pressure.js` |
157170
| Temperature | `temperature.js` |
158171

159-
### Example Translation Update (`humidity.js`)
172+
#### Example Translation Update (`humidity.js`)
160173

161174
To add support for **Spanish (es)**, update the `name`, `nameshort`, and `zones` properties:
162175

@@ -186,6 +199,9 @@ To add support for **Spanish (es)**, update the `name`, `nameshort`, and `zones`
186199
]
187200
```
188201

202+
---
203+
204+
189205
## ❓ Support
190206

191207
For questions or suggestions, create an **issue** in the repository.

0 commit comments

Comments
 (0)