Skip to content

Commit fe9c29a

Browse files
committed
Update README.md to enhance library usage instructions and installation guide
1 parent a4e14d8 commit fe9c29a

File tree

1 file changed

+58
-52
lines changed

1 file changed

+58
-52
lines changed

README.md

Lines changed: 58 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,60 @@
11
# PxServ
22

3-
## Kullanım / Usage
4-
5-
```cpp
6-
#include <WiFi.h>
7-
#include <PxServ.h>
8-
9-
// Wi-Fi ayarları (Wi-Fi SSID ve Şifre)
10-
#define WIFI_SSID "your_wifi_ssid" // Wi-Fi Adı
11-
#define WIFI_PASS "your_wifi_password" // Wi-Fi Şifresi
12-
13-
// PxServ API Key (Proje API Anahtarınızı buraya ekleyin)
14-
PxServ client("your_pxserv_api_key");
15-
16-
void setup()
17-
{
18-
// Seri haberleşmeyi başlat
19-
Serial.begin(115200);
20-
21-
// Wi-Fi'a bağlan
22-
WiFi.begin(WIFI_SSID, WIFI_PASS);
23-
Serial.print("Wi-Fi'ya bağlanıyor...");
24-
25-
// Bağlantı sağlanana kadar bekle
26-
while (WiFi.status() != WL_CONNECTED)
27-
{
28-
Serial.print(".");
29-
delay(500); // Bağlantı sürecini yavaşlatmak için kısa bir gecikme eklenebilir
30-
}
31-
Serial.println("Bağlandı!");
32-
}
33-
34-
void loop()
35-
{
36-
// Veri ekle (Set Data)
37-
PxServ::Callback setResult = client.setData("msg", "value"); // "msg" anahtarına "value" değerini ekle
38-
Serial.println("Set Result -> Status: " + String(setResult.status) + " | Message: " + String(setResult.message) + " | Data: " + String(setResult.data));
39-
40-
delay(2000); // İki saniye bekle
41-
42-
// Veri al (Get Data)
43-
PxServ::Callback getResult = client.getData("msg"); // "msg" anahtarı için değeri getir
44-
Serial.println("Get Result -> Status: " + String(getResult.status) + " | Message: " + String(getResult.message) + " | Data: " + String(getResult.data));
45-
46-
delay(2000); // İki saniye bekle
47-
48-
// Veri kaldır (Remove Data)
49-
PxServ::Callback removeResult = client.removeData("msg"); // "msg" anahtarını kaldır
50-
Serial.println("Remove Result -> Status: " + String(removeResult.status) + " | Message: " + String(removeResult.message) + " | Data: " + String(removeResult.data));
51-
52-
delay(2000); // İki saniye bekle
53-
}
54-
```
3+
`PxServ` is an Arduino library that allows you to save and manage your data in the PxServ database in a simple and effective way. It is also compatible with ESP32 and ESP8266.
4+
5+
`PxServ`, verilerinizi basit ve etkili bir şekilde PxServ veritabanına kaydetmenizi ve yönetmenizi sağlayan bir Arduino kütüphanesidir. Ayrıca ESP32 ve ESP8266 ile uyumludur.
6+
7+
## Installation / Kurulum
8+
9+
You can add the library to your project using the Arduino Library Manager or manually:
10+
11+
Kütüphaneyi Arduino Library Manager veya manuel olarak projenize ekleyebilirsiniz:
12+
13+
### Using Arduino Library Manager / Arduino Library Manager Kullanarak
14+
15+
**English:**
16+
17+
1. Open the Arduino IDE.
18+
2. Go to `Sketch` > `Include Library` > `Manage Libraries...`.
19+
3. Search for `PxServ`.
20+
4. Click `Install`.
21+
22+
**Türkçe:**
23+
24+
1. Arduino IDE'yi açın.
25+
2. `Sketch` > `Include Library` > `Manage Libraries...` menüsüne gidin.
26+
3. `PxServ` araması yapın.
27+
4. `Install` butonuna tıklayın.
28+
29+
### Manual Installation / Manuel Kurulum
30+
31+
**English:**
32+
33+
1. Download the latest release from the [PxServ releases page](https://github.com/pxserv/pxserv.arduino/releases).
34+
2. Extract the downloaded ZIP file.
35+
3. Move the extracted folder to your Arduino libraries directory (usually located in `Documents/Arduino/libraries`).
36+
37+
**Türkçe:**
38+
39+
1. [PxServ releases sayfasından](https://github.com/pxserv/pxserv.arduino/releases) en son sürümü indirin.
40+
2. İndirilen ZIP dosyasını çıkarın.
41+
3. Çıkarılan klasörü Arduino kütüphaneleri dizinine taşıyın (genellikle `Documents/Arduino/libraries` konumunda bulunur).
42+
43+
## Usage / Kullanım
44+
45+
For detailed usage, please refer to the documentation:
46+
47+
Daha detaylı kullanım için lütfen dokümantasyona bakınız:
48+
49+
- [English Documentation](https://docs.pxserv.net/en/arduino-library)
50+
- [Türkçe Dokümantasyon](https://docs.pxserv.net/tr/arduino-kutuphanesi)
51+
52+
## Contributing / Katkıda Bulunma
53+
54+
If you would like to contribute, you can fork the project and develop on your own branch. We would be happy to review your changes!
55+
56+
Katkıda bulunmak isterseniz, projeyi forklayarak kendi branch'inizde geliştirme yapabilirsiniz. Değişikliklerinizi incelemekten memnuniyet duyarız!
57+
58+
## License / Lisans
59+
60+
[![MIT License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

0 commit comments

Comments
 (0)