india-state-city 1.0.0

package/README.md

@@ -0,0 +1,41 @@
+# india-state-city
+
+A lightweight library to get the list of States in India and Cities within those States.
+
+## Installation
+
+```bash
+npm install india-state-city
+```
+
+## Usage
+
+### Get all States of India
+
+```javascript
+const { State } = require('india-state-city');
+
+const states = State.getAllStates();
+console.log(states);
+```
+
+### Get Cities of a State
+
+You need to provide the `stateCode` (e.g., 'MH' for Maharashtra, 'DL' for Delhi).
+
+```javascript
+const { City } = require('india-state-city');
+
+const cities = City.getCitiesOfState('MH');
+console.log(cities);
+```
+
+## API Reference
+
+### State
+- `getAllStates()`: Returns an array of all states in India.
+- `getStateByCode(stateCode)`: Returns details of a specific state by its code.
+
+### City
+- `getAllCities()`: Returns an array of all cities in India.
+- `getCitiesOfState(stateCode)`: Returns an array of cities for a given state code.