allenhwkim / angularjs-google-maps

The Simplest AngularJS Google Maps V3 Directive
http://ngmap.github.io
MIT License
1.52k stars 517 forks source link

Need Documentation #814

Open siddmegadeth opened 7 years ago

siddmegadeth commented 7 years ago

The documentation part is very poor. Even though most features are covered but due to lack of documentation deter us from using it for enterprise environment.

Documentation should be provided.

IMPORTANT:

This repository's issues are reserved for feature requests and bug reports. Do not submit support questions or request here. Please use stackoverflow instead

Steps to reproduce and a minimal demo(Plunker Example)

Current behavior

Expected/desired behavior

Other information

blackn1ght commented 7 years ago

@siddmegadeth Totally agree. It's really difficult getting started using this.

For example, nothing in documentation tells you the relationship between the ng-map directive in the HTML and the getMap function that you use in the controller. Most examples just show hard coded values directly on the directive.

It really needs a simple "Getting Started", how to do basics, such as load a map and set a position once it's initialised, and so on.

allenhwkim commented 7 years ago

Looking for a volunteer to create GETTING-STARTED.md

siddmegadeth commented 7 years ago

If possible i can help with documentation but i need access to all feature and functionalities docs before i can com eup with a starter.