search

TreewareEarth / treeware.earth

Code that powers https://treeware.earth
MIT License
27 stars 5 forks source link

Include more detailed docs on how to use everything #16

Open jamesmills opened 3 years ago

jamesmills commented 3 years ago

There are many ways to use the API and show tree counts etc

What Description URL Example
Plant Trees Plant trees for a Treeware Package https://plant.treeware.earth/{owner}/{package} https://plant.treeware.earth/TreewareEarth/treeware.earth
Ecology Trees Get total trees for Treeware using Ecologi API https://public.ecologi.com/users/{username}/trees https://public.ecologi.com/users/treeware/trees
Package Tree Count Get total trees for a package direct from Ecologi API https://public.ecologi.com/users/treeware/trees?ref={md5(lower(owner/package))} https://public.ecologi.com/users/treeware/trees?ref= 25902d590afd58548096050d4a97bc8f
Shield.io Package Trees Get a badge to show number of trees planted by a package in the Treeware Forrest https://img.shields.io/treeware/trees/{owner}/{package} https://img.shields.io/treeware/trees/treewareearth/treeware.earth
Shield.io Ecologi Trees Get a badge to show total trees in the Forrest for a Ecologi username https://img.shields.io/ecologi/trees/{username} https://img.shields.io/ecologi/trees/treeware