Skip to content

Commit 01b116f

Browse files
committed
update README
1 parent 5671760 commit 01b116f

1 file changed

Lines changed: 20 additions & 49 deletions

File tree

README.md

Lines changed: 20 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -2,56 +2,27 @@
22

33
![GitHub release](https://img.shields.io/github/v/release/AstroDraw/AstroChart?style=flat-square)
44

5-
A free and open-source JavaScript library for generating SVG charts to display planets in astrology. It does not calculate any positions of the planets in Universe.
5+
A free and open-source TypeScript library for generating SVG charts to display planets in astrology. It does not calculate any positions of the planets in Universe.
66

7-
- Pure Javascript implementation without dependencies.
7+
- Pure TypeScript implementation without dependencies.
88
- SVG graphics.
99
- Tested code.
1010

11-
### Example
12-
- [Radix chart](./project/examples/radix/radix.html)
13-
- [Radix 15. 11. 2016](./project/examples/radix/radix_2016_11_15.html)
14-
- [Radix collision](./project/examples/radix/radix_collision.html)
15-
- [Transit chart](./project/examples/transit/transit.html)
16-
- [Stroke only](./project/examples/transit/stroke_only.html)
17-
- [Animation](./project/examples/transit/animate.html)
18-
- [Calibration](./project/examples/debug/calibration.html)
19-
- [2 charts on page](./project/examples/2ChartsOnPage/2radix.html)
20-
21-
22-
### How to use
23-
```
24-
<script src="js/astrochart.min.js"></script>
25-
<script>
26-
window.onload = function(){
27-
var chart = new astrology.Chart( 'paper', 800, 800);
28-
chart.radix( data );
29-
};
30-
</script>
31-
```
32-
### Known points
33-
Sun, Moon, Mercury, Venus, Mars, Jupiter, Saturn, Uranus, Neptune, Pluto, Chiron, Lilith, NNode.
34-
35-
### Data example
36-
```
37-
{
38-
"planets":{"Moon":[0], "Sun":[30], "Mercury":[60], ... },
39-
"cusps":[300, 340, 30, 60, 75, 90, 116, 172, 210, 236, 250, 274]
40-
}
41-
```
42-
43-
### Chart settings
44-
Look into the [settings.js](https://github.com/AstroDraw/AstroChart/blob/main/project/src/settings.js)
45-
```
46-
var settings = {SYMBOL_SCALE:2};
47-
var chart = new astrology.Chart( 'paper', 800, 800, settings);
48-
```
49-
50-
### People
51-
**Creator**: [Kibo](https://github.com/Kibo)
52-
**Mantainer**: [afucher](https://github.com/afucher)
53-
54-
### It might interest you
55-
- [The Swiss Ephemeris](http://www.astro.com/swisseph/swephinfo_e.htm)
56-
- [AstroWebService](https://github.com/Kibo/AstroWebService)
57-
- [AstroAPI](https://github.com/Kibo/AstroAPI)
11+
## Documentation
12+
A documentation is in progress, please checkout [website](astrodraw.github.io).
13+
14+
## Contribution
15+
Contribution is always welcome. You can contribute in different ways:
16+
- Start or participate in the [discussions](https://github.com/AstroDraw/AstroChart/discussions)
17+
- Check opened issues, or improve our documentation
18+
- Open [an issue](https://github.com/AstroDraw/AstroChart/issues) to report a bug or give some enchancement idea
19+
- Open a PR with bug fixes or new features. To avoid rework, if is not small, is always good to open an issue to discuss before.
20+
21+
## Support
22+
Do you want to support the development of AstroChart? Here is some ways:
23+
24+
Is your project using? Please [comment here](https://github.com/AstroDraw/AstroChart/discussions/48) so we can share nice projects that are using.
25+
26+
A nice way to support is sharing this project with other people.
27+
28+
Also, if you are a company consider sponsoring the project or [buying me a coffee](https://ko-fi.com/afucher)

0 commit comments

Comments
 (0)