Improve documentation

[zefir-git]

The README.md (presumably the documentation for this project) lacks essential information for the usage of this software.

The options are not defined. Instead, you have a link to the source code. However, the link is not a permalink tied to a specific commit. In any case, reading the source to try to understand how to use it is not enjoyable. This is also the case for styling and almost everything else.

chartjs-chart-geo/src/controllers/GeoController.ts

Lines 225 to 230 in 3d92cd1

	/**
	* Outline used to scale and centralize the projection in the chart area.
	* By default a sphere is used
	* @default { type: 'Sphere" }
	*/
	outline: any[];

Except for {type: "sphere"}, what other options can be passed? Type any[] does not particularly help me understand.

Well-formed documentation would be most welcome.

[zefir-git]

@sgratzl No comment?

[contis2908]

I agree with @zefir-git. I am having a hard time understanding the examples too.
First of all the provided codepen doesn't show any imports so I have to manually look into the installed package and find the exports.
Secondly, the examples provided on GitHub https://github.com/sgratzl/chartjs-chart-geo/blob/main/docs/examples/bubbleMap.ts do import things but from my understanding, these should be part of your package import { Feature, topojson } from '../../src';

The codepen uses ChartGeo.topojson so I usually would figure that is what I need to import. However, this is not part of your export and on top, it throws a TS error that it now requires GeoFeature.

Overall I find this to be quite confusing