Skip to content

Commit

Permalink
docs: add language button, fix link to installation & contributing files
Browse files Browse the repository at this point in the history
  • Loading branch information
fityannugroho committed Oct 7, 2023
1 parent 322f206 commit 81fae3c
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 9 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@
<a href="https://www.mysql.com"><img alt="MySQL" src="https://img.shields.io/badge/-MySQL-00688F?style=flat-square&logo=mysql&logoColor=white" /></a>
</p>

**English** | [हिन्दी](docs/README_hi.md) | [Tagalog](docs/README_tl.md)

API that provides information on the **administrative areas of Indonesia**, from the province, regency, district, to village levels. It also provides island data since [version 1.1.0](https://github.com/fityannugroho/idn-area/releases/tag/v1.1.0).

Built with [NestJS framework](https://nestjs.com) and writen in TypeScript. [Prisma](https://www.prisma.io) is used as the ORM to interact with any kind of databases (MySQL, PostgreSQL, and MongoDB).
Expand Down Expand Up @@ -59,7 +61,7 @@ These are some sample projects that using this API :

## Contributing

If you want to contribute to this project, please read the [CONTRIBUTING.md](CONTRIBUTING.md) file and make sure you follow the [Pull Request guide](CONTRIBUTING.md#submitting-a-pull-request)
If you want to contribute to this project, please read the [CONTRIBUTING.md](CONTRIBUTING.md) file and make sure you follow the [Pull Request guide](CONTRIBUTING.md#submitting-a-pull-request).

## Problem Reporting

Expand Down
10 changes: 6 additions & 4 deletions docs/README_hi.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@
<a href="https://www.mysql.com"><img alt="माई एसक्यूएल" src="https://img.shields.io/badge/-MySQL-00688F?style=flat-square&logo=mysql&logoColor=white" /></a>
</p>

[English](../README.md) | **हिन्दी** | [Tagalog](README_tl.md)

एपीआई जो इंडोनेशिया के **प्रशासनिक क्षेत्रों**, प्रांत, रीजेंसी, जिले से लेकर ग्राम स्तर तक की जानकारी प्रदान करता है। यह [संस्करण 1.1.0](https://github.com/fityannugroho/idn-area/releases/tag/v1.1.0) से द्वीप डेटा भी प्रदान करता है।

[नेस्ट जे एस फ्रेमवर्क](https://nestjs.com) के साथ निर्मित और टाइपस्क्रिप्ट में लिखा गया है। [प्रिज्मा](https://www.prisma.io) का उपयोग किसी भी प्रकार के डेटाबेस के साथ इंटरैक्ट करने के लिए ORM के रूप में किया जाता है(माई एसक्यूएल, पोस्टग्रेएसक्यूएल, और मोंगो डी बी)।
Expand All @@ -34,7 +36,7 @@

## शुरू करना

कृपया इस ऐप को इंस्टॉल और चलाने के लिए [इंस्टॉलेशन गाइड](docs/installation.md) पढ़ें।
कृपया इस ऐप को इंस्टॉल और चलाने के लिए [इंस्टॉलेशन गाइड](installation.md) पढ़ें।

## डेटा

Expand All @@ -58,17 +60,17 @@
- [आईडीएन-क्षेत्र मानचित्र](https://github.com/fityannugroho/idn-area-map)

## योगदान
यदि आप इस परियोजना में योगदान देना चाहते हैं, तो कृपया [CONTRIBUTING.md](CONTRIBUTING.md) फ़ाइल पढ़ें और सुनिश्चित करें कि आप [पुल अनुरोध गाइड](CONTRIBUTING.md#submitting-a-pull-request) का पालन करें
यदि आप इस परियोजना में योगदान देना चाहते हैं, तो कृपया [CONTRIBUTING.md](../CONTRIBUTING.md) फ़ाइल पढ़ें और सुनिश्चित करें कि आप [पुल अनुरोध गाइड](../CONTRIBUTING.md#submitting-a-pull-request) का पालन करें.

## समस्या रिपोर्टिंग

हमारे पास प्रत्येक समस्या के लिए अलग-अलग चैनल हैं, कृपया इन शर्तों का पालन करते हुए उनका उपयोग करें:

### बग की रिपोर्ट करना
बग की रिपोर्ट करने के लिए, कृपया [गाइड](CONTRIBUTING.md#submitting-an-issue) का पालन करते हुए एक नया अंक खोलें.
बग की रिपोर्ट करने के लिए, कृपया [गाइड](../CONTRIBUTING.md#submitting-an-issue) का पालन करते हुए एक नया अंक खोलें.

### एक नई सुविधा का अनुरोध
यदि आपके मन में कोई नई सुविधा है, तो कृपया [गाइड](CONTRIBUTING.md#submitting-an-issue) का पालन करते हुए एक नया अंक खोलें।
यदि आपके मन में कोई नई सुविधा है, तो कृपया [गाइड](../CONTRIBUTING.md#submitting-an-issue) का पालन करते हुए एक नया अंक खोलें।

### एक प्रश्न पूछना
यदि आपके पास कोई प्रश्न है, तो आप [GitHub चर्चाएँ Q&A श्रेणी](https://github.com/fityannugroho/idn-area/discussions/categories/q-a) में उत्तर खोज सकते हैं। यदि आपको पहले से कोई प्रासंगिक चर्चा नहीं मिलती है, तो आप एक नई चर्चा खोल सकते हैं।
Expand Down
10 changes: 6 additions & 4 deletions docs/README_tl.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@
<a href="https://www.mysql.com"><img alt="MySQL" src="https://img.shields.io/badge/-MySQL-00688F?style=flat-square&logo=mysql&logoColor=white" /></a>
</p>

[English](../README.md) | [हिन्दी](README_hi.md) | **Tagalog**

API na nagbibigay ng impormasyon tungkol sa **Mga administratibong lugar sa Indonesia**, sa antas ng lalawigan, bayan, distrito, hanggang sa mga barangay. Isinasama rin nito ang datos tungkol sa mga isla simula [bersyon 1.1.0](https://github.com/fityannugroho/idn-area/releases/tag/v1.1.0).

Ginawa gamit ang [NestJS framework](https://nestjs.com) At isinulat sa TypeScript. [Prisma](https://www.prisma.io) ay ginagamit bilang ORM upang makipag-ugnay sa anumang uri ng mga database (MySQL, PostgreSQL, at MongoDB).
Expand All @@ -34,7 +36,7 @@ Ginawa gamit ang [NestJS framework](https://nestjs.com) At isinulat sa TypeScrip

## Pagsisimula

Pakibasa ang [gabay sa Pag-Install](docs/installation.md) upang i-install at patakbuhin ang aplikasyong ito.
Pakibasa ang [gabay sa Pag-Install](installation.md) upang i-install at patakbuhin ang aplikasyong ito.

## Data

Expand All @@ -59,17 +61,17 @@ Ito ay ilang halimbawang proyekto na gumagamit ng API na ito :

## Nagbibigay ng kontribusyon

Kung nais mong mag-ambag sa proyektong ito, mangyaring basahin ang [CONTRIBUTING.md](CONTRIBUTING.md) na file at Siguruhing sumusunod ka sa [Gabay sa Pull Request](CONTRIBUTING.md#submitting-a-pull-request)
Kung nais mong mag-ambag sa proyektong ito, mangyaring basahin ang [CONTRIBUTING.md](../CONTRIBUTING.md) na file at Siguruhing sumusunod ka sa [Gabay sa Pull Request](../CONTRIBUTING.md#submitting-a-pull-request).

## Ulat ng Problema

May iba't-ibang mga channel para sa bawat problema, mangyaring gamitin ang mga ito sa pamamagitan ng pagsunod sa mga kondisyon na ito :

### Pag-uulat ng Isang Bug
Upang mag-ulat ng bug, mangyaring buksan ang isang bagong isyu ayon sa [gabay](CONTRIBUTING.md#submitting-an-issue).
Upang mag-ulat ng bug, mangyaring buksan ang isang bagong isyu ayon sa [gabay](../CONTRIBUTING.md#submitting-an-issue).

### Humihiling ng Bagong Tampok
Kung mayroon kang bagong tampok sa isip, mangyaring buksan ang isang bagong isyu ayon sa [gabay](CONTRIBUTING.md#submitting-an-issue).
Kung mayroon kang bagong tampok sa isip, mangyaring buksan ang isang bagong isyu ayon sa [gabay](../CONTRIBUTING.md#submitting-an-issue).

### Nagtatanong ng Tanong
Kung mayroon kang tanong, maaari kang maghanap ng mga sagot sa [Kategorya ng GitHub Discussions Q&A](https://github.com/fityannugroho/idn-area/discussions/categories/q-a). Kung wala kang makitang kaugnay na pag-uusap na umiiral na, maari kang magbukas ng isang bagong pag-uusap.
Expand Down

0 comments on commit 81fae3c

Please sign in to comment.