8000 Update README.md (#152) · polygon-io/client-js@dec95b3 · GitHub
[go: up one dir, main page]
Skip to content

Commit dec95b3

Browse files
justinpolygonjustinpolygon
authored
Update README.md (#152)
* Update README.md Updated the readme for better formatting and included a link to the new getting started tutorial. * Update README.md Fix examples path
1 parent 470a946 commit dec95b3

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

‎README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
44

5-
The official JS client library for the [Polygon](https://polygon.io/) REST and WebSocket API. Explore the 67E5 [REST API](https://polygon.io/docs/stocks/getting-started) documentation and many example [code snippets](./examples/). Please see the [Release Notes](./CHANGELOG.md) for instructions on upgrading. To generate the package documentation please run `npm run generate-doc`.
5+
Welcome to the official JS client library for the [Polygon](https://polygon.io/) REST and WebSocket API. To get started, please see the [Getting Started](https://polygon.io/docs/stocks/getting-started) section in our documentation, view the [examples](./examples/) directory for code snippets, or the [blog post](https://polygon.io/blog/javascript-stock-market-data/) with video tutorials to learn more. To generate the package documentation please run `npm run generate-doc`.
6+
7+
For upgrade instructions please see the [Release Notes](./CHANGELOG.md).
68

79
## Getting the client
810

0 commit comments

Comments
 (0)
0