Skip to content

Commit 7fdd8c1

Browse files
authored
docs: some readme and docs updates (#38)
* docs: some readme and docs updates * fix: formatting * feat: add image
1 parent d0d307e commit 7fdd8c1

File tree

3 files changed

+51
-4
lines changed

3 files changed

+51
-4
lines changed

README.md

Lines changed: 35 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,43 @@
11
# stac-map
22

3-
A map-first STAC visualizer, hosted at <https://developmentseed.org/stac-map>.
3+
[![CI status](https://img.shields.io/github/actions/workflow/status/developmentseed/stac-map/ci.yaml?style=for-the-badge&label=CI)](https://github.com/developmentseed/stac-map/actions/workflows/ci.yaml)
4+
[![Deploy status](https://img.shields.io/github/actions/workflow/status/developmentseed/stac-map/deploy.yaml?style=for-the-badge&label=Deploy)](https://github.com/developmentseed/stac-map/actions/workflows/deploy.yaml)
5+
6+
The map-first STAC visualizer at <https://developmentseed.org/stac-map>.
7+
8+
![stac-map](./img/stac-map.png)
49

510
Includes:
611

712
- Natural language collection search
813
- **stac-geoparquet** visualization
9-
- Upload and view a file from your local filesystem
1014

11-
> [!NOTE]
12-
> This is a prototype, and might change significantly and/or break at any time.
15+
> [!WARNING]
16+
> This application is in its infancy :baby: and will change significantly and/or break at any time.
17+
18+
## Development
19+
20+
Get [yarn](https://yarnpkg.com/), then:
21+
22+
```shell
23+
git clone git@github.com:developmentseed/stac-map
24+
cd stac-map
25+
yarn install
26+
yarn dev
27+
```
28+
29+
This will open a development server at <http://localhost:5173/stac-map/>
30+
We have some code quality checks/tools:
31+
32+
```shell
33+
yarn lint
34+
yarn format
35+
```
36+
37+
## Contributing
38+
39+
We use Github [Pull Requests](https://github.com/developmentseed/stac-map/pulls) to propose changes, and [Issues](https://github.com/developmentseed/stac-map/issues) to report bugs and request features.
40+
41+
## Deploying
42+
43+
See [deploy.yaml](./.github/workflows/deploy.yaml) for a (drop-dead simple) example of deploying this application as a static site via Github Pages.

img/stac-map.png

627 KB
Loading

package.json

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,21 @@
11
{
22
"name": "stac-map",
3+
"description": "A map-first, static-site STAC visualizer",
4+
"author": {
5+
"name": "Pete Gadomski",
6+
"email": "pete.gadomski@gmail.com"
7+
},
8+
"contributors": [
9+
{
10+
"name": "Indraneel Purohit",
11+
"email": "indraneelpurohit@gmail.com"
12+
}
13+
],
14+
"homepage": "https://github.com/developmentseed/stac-map/",
15+
"bugs": {
16+
"url": "https://github.com/developmentseed/stac-map/issues"
17+
},
18+
"license": "MIT",
319
"private": true,
420
"version": "0.0.0",
521
"type": "module",

0 commit comments

Comments
 (0)