Skip to content

Commit 0d1a5c5

Browse files
committed
docs(README): update package readme
1 parent bf51d03 commit 0d1a5c5

File tree

1 file changed

+113
-36
lines changed

1 file changed

+113
-36
lines changed

packages/stadata_flutter_sdk/README.md

Lines changed: 113 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -49,45 +49,122 @@ For detailed usage instructions and documentation of this package, please refer
4949

5050
---
5151

52-
## To-Do
53-
54-
### List API TODO
55-
56-
- ✅ Domains
57-
- ✅ Publications
58-
- ✅ Infographics
59-
- ✅ Static Table
60-
- 🔄 Dynamic Table
61-
- ✅ Press Release
62-
- ✅ News
63-
- ✅ News Categories
64-
- ✅ Subject Categories
65-
- ✅ Subjects
66-
- ✅ KBLI
67-
- 🔄 Glosarium
68-
- 🔄 Census Data
69-
- 🔄 SIMDASI
70-
- 🔄 Foreign Trade (Exim)
71-
- 🔄 SDGs Data
72-
- ✅ Strategic Indicator
73-
- 🔄 SDDS
74-
- ✅ Unit
75-
- ✅ Variable
76-
- ✅ Vertical Variable
77-
78-
### View API TODO
79-
80-
- ✅ Publication
81-
- ✅ Static Table
82-
- 🔄 Dynamic Table
83-
- ✅ Press Release
84-
- ✅ News
85-
- ✅ News Category
86-
- ✅ KBLI
52+
## 🚀 Getting Started
53+
54+
### Prerequisites
55+
56+
- Flutter SDK `>=3.7.0 <4.0.0`
57+
- An API key from [BPS WebAPI](https://webapi.bps.go.id/developer/)
58+
59+
### Installation
60+
61+
Add this package to your `pubspec.yaml`:
62+
63+
```yaml
64+
dependencies:
65+
stadata_flutter_sdk: ^latest_version
66+
```
67+
68+
### Quick Example
69+
70+
```dart
71+
import 'package:stadata_flutter_sdk/stadata_flutter_sdk.dart';
72+
73+
// Initialize the SDK
74+
final stadata = StadataFlutter.instance;
75+
await stadata.init(apiKey: 'your_api_key_here');
76+
77+
// Fetch domains
78+
final domains = await stadata.list.domains(
79+
lang: DataLanguage.id,
80+
type: DomainType.all,
81+
);
82+
83+
// Fetch publications
84+
final publications = await stadata.list.publications(
85+
lang: DataLanguage.en,
86+
domain: '0000',
87+
);
88+
```
89+
90+
For more detailed examples, check our [example app](app/example) or visit the [documentation](https://ryanaidilp.github.io/stadata_flutter_sdk/).
8791

8892
---
8993

90-
## Contributors
94+
## 🛠️ Development Status
95+
96+
### List API Implementation
97+
98+
| Feature | Status | Description |
99+
| --------------------------- | ------ | ----------------------------------- |
100+
| Domains || Geographic administrative divisions |
101+
| Publications || BPS publications and reports |
102+
| Infographics || Statistical infographics |
103+
| Static Tables || Pre-defined statistical tables |
104+
| Press Releases || Official press releases |
105+
| News || Statistical news and updates |
106+
| News Categories || News categorization |
107+
| Subject Categories || Statistical subject hierarchies |
108+
| Subjects || Statistical subjects |
109+
| Statistical Classifications || KBLI & KBKI classifications |
110+
| Strategic Indicators || Key performance indicators |
111+
| Units || Measurement units |
112+
| Variables || Statistical variables |
113+
| Vertical Variables || Vertical measurement variables |
114+
| Census Data || Census information and datasets |
115+
| Dynamic Tables | 🔄 | Dynamic statistical tables |
116+
| Glossary | 🔄 | Statistical terms glossary |
117+
| Foreign Trade | 🔄 | Export/import statistics |
118+
| SDGs Data | 🔄 | Sustainable Development Goals |
119+
120+
### View API Implementation
121+
122+
| Feature | Status | Description |
123+
| --------------------------- | ------ | --------------------------- |
124+
| Publications || Detailed publication view |
125+
| Static Tables || Detailed table view |
126+
| Press Releases || Detailed press release view |
127+
| News || Detailed news view |
128+
| News Categories || Category details |
129+
| Statistical Classifications || Classification details |
130+
| Dynamic Tables | 🔄 | Dynamic table details |
131+
132+
**Legend:** ✅ Complete | 🔄 In Progress | ❌ Not Started
133+
134+
---
135+
136+
## 🤝 Contributing
137+
138+
We welcome contributions from the community! Whether you're fixing bugs, adding features, improving documentation, or helping with translations, your contributions are valuable.
139+
140+
### Quick Start for Contributors
141+
142+
1. **👋 New to Contributing?** Read our [Contributor Guide](CONTRIBUTOR_GUIDE_EN.md) | [Panduan Kontributor](CONTRIBUTOR_GUIDE.md)
143+
2. **🔍 First Time?** Check our [Contribution Guidelines](CONTRIBUTING.md)
144+
3. **🚀 New Feature?** Follow our [Feature Development Workflow](FEATURE_DEVELOPMENT_WORKFLOW_EN.md) | [Panduan Pengembangan Fitur](FEATURE_DEVELOPMENT_WORKFLOW.md)
145+
4. **📋 GitHub Process?** See our [GitHub Contribution Workflow](GITHUB_CONTRIBUTION_WORKFLOW_EN.md) | [Alur Kontribusi GitHub](GITHUB_CONTRIBUTION_WORKFLOW.md)
146+
147+
### Ways to Contribute
148+
149+
- 🐛 **Bug Reports**: Found an issue? [Report it here](https://github.com/ryanaidilp/stadata_flutter_sdk/issues/new/choose)
150+
-**Feature Requests**: Have an idea? [Suggest it here](https://github.com/ryanaidilp/stadata_flutter_sdk/issues/new/choose)
151+
- 📝 **Documentation**: Help improve our docs
152+
- 🧪 **Testing**: Write tests to improve coverage
153+
- 🌍 **Localization**: Help translate the example app
154+
- 🔄 **Pending Features**: Help implement features marked with 🔄
155+
156+
### Good First Issues
157+
158+
Look for issues labeled [`good first issue`](https://github.com/ryanaidilp/stadata_flutter_sdk/labels/good%20first%20issue) - these are perfect for newcomers!
159+
160+
### Documentation
161+
162+
- 📖 [API Documentation](https://ryanaidilp.github.io/stadata_flutter_sdk/)
163+
- 🎯 [Contribution Guidelines](CONTRIBUTING.md)
164+
- 🔧 [Feature Development Guide](FEATURE_DEVELOPMENT_WORKFLOW_EN.md) | [Panduan Pengembangan Fitur](FEATURE_DEVELOPMENT_WORKFLOW.md)
165+
- 🔄 [GitHub Workflow](GITHUB_CONTRIBUTION_WORKFLOW_EN.md) | [Alur Kontribusi GitHub](GITHUB_CONTRIBUTION_WORKFLOW.md)
166+
- 📋 [Contribution Workflow](CONTRIBUTION_WORKFLOW_EN.md) | [Alur Kontribusi](CONTRIBUTION_WORKFLOW.md)
167+
- 🏗️ [Architecture Guide](CLAUDE.md)
91168

92169
<a href="https://github.com/ryanaidilp/stadata_flutter_sdk/graphs/contributors">
93170
<img src="https://contrib.rocks/image?repo=ryanaidilp/stadata_flutter_sdk" />

0 commit comments

Comments
 (0)