Skip to content

Commit f3854b2

Browse files
Ibrahim RahhalIbrahim Rahhal
Ibrahim Rahhal
authored and
Ibrahim Rahhal
committed
adding readmen
1 parent d0fc815 commit f3854b2

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

README.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
2+
# Jordan Cities GeoJSON
3+
This is a package/ repositry that contains geoJSON info for all Jordan cities.
4+
5+
6+
## Getting Started
7+
8+
To begin, you'll need to install `jordan-cities-geojson`:
9+
10+
```console
11+
npm install --save jordan-cities-geojson
12+
```
13+
14+
Then import the GeoJSON data for the city that you want
15+
16+
**my-cool-map-app.js**
17+
18+
```js
19+
const { Amman } = require('jordan-cities-geojson');
20+
```
21+
To import all cities just require the whole package
22+
23+
```js
24+
const JordanCities = require('jordan-cities-geojson');
25+
```
26+
27+
28+
## Contributing
29+
30+
Please take a moment to read our contributing guidelines if you haven't yet done so.
31+
32+
[CONTRIBUTING](./.github/CONTRIBUTING.md)
33+
34+
## License
35+
36+
[MIT](./LICENSE)

0 commit comments

Comments
 (0)