diff --git a/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md similarity index 100% rename from CODE_OF_CONDUCT.md rename to .github/CODE_OF_CONDUCT.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 00000000..1d1e35c5 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,26 @@ +## How to contribute to Tile38 + +Before getting starting with contributing, please know that we currently use [Tile38 Slack](https://tile38.com/slack) channel for casual questions and user chat. + +### Did you find a bug? + +- **Do not open up a GitHub issue if the bug is a security vulnerability in Tile38**. Sensitive security-related issues should be reported to [security@tile38.com](mailto:security@tile38.com). + +- **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/tidwall/tile38/issues). +- If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/tidwall/tile38/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring. + +### Did you write a patch that fixes a bug? + +- Open a new GitHub pull request with the patch. +- Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable. + +### Did you fix whitespace, format code, or make a purely cosmetic patch? + +Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability of Tile38 will generally not be accepted. + +### Do you intend to add a new feature or change an existing one? + +- Suggest your change in [a new issue](https://github.com/tidwall/tile38/issues/new) or in the [Tile38 Slack](https://tile38.com/slack), and start writing code. +- Do not open an issue on GitHub until you have collected positive feedback about the change. GitHub issues are primarily intended for bug reports and fixes. + +Thanks! \ No newline at end of file diff --git a/internal/assets/geofence.gif b/.github/images/geofence.gif similarity index 100% rename from internal/assets/geofence.gif rename to .github/images/geofence.gif diff --git a/internal/assets/logo-small.png b/.github/images/logo-small.png similarity index 100% rename from internal/assets/logo-small.png rename to .github/images/logo-small.png diff --git a/internal/assets/logo.png b/.github/images/logo.png similarity index 100% rename from internal/assets/logo.png rename to .github/images/logo.png diff --git a/internal/assets/roaming.gif b/.github/images/roaming.gif similarity index 100% rename from internal/assets/roaming.gif rename to .github/images/roaming.gif diff --git a/internal/assets/search-intersects.png b/.github/images/search-intersects.png similarity index 100% rename from internal/assets/search-intersects.png rename to .github/images/search-intersects.png diff --git a/internal/assets/search-nearby.png b/.github/images/search-nearby.png similarity index 100% rename from internal/assets/search-nearby.png rename to .github/images/search-nearby.png diff --git a/internal/assets/search-plain.png b/.github/images/search-plain.png similarity index 100% rename from internal/assets/search-plain.png rename to .github/images/search-plain.png diff --git a/internal/assets/search-within.png b/.github/images/search-within.png similarity index 100% rename from internal/assets/search-within.png rename to .github/images/search-within.png diff --git a/internal/assets/sparse-1.png b/.github/images/sparse-1.png similarity index 100% rename from internal/assets/sparse-1.png rename to .github/images/sparse-1.png diff --git a/internal/assets/sparse-2.png b/.github/images/sparse-2.png similarity index 100% rename from internal/assets/sparse-2.png rename to .github/images/sparse-2.png diff --git a/internal/assets/sparse-3.png b/.github/images/sparse-3.png similarity index 100% rename from internal/assets/sparse-3.png rename to .github/images/sparse-3.png diff --git a/internal/assets/sparse-4.png b/.github/images/sparse-4.png similarity index 100% rename from internal/assets/sparse-4.png rename to .github/images/sparse-4.png diff --git a/internal/assets/sparse-5.png b/.github/images/sparse-5.png similarity index 100% rename from internal/assets/sparse-5.png rename to .github/images/sparse-5.png diff --git a/internal/assets/sparse-6.png b/.github/images/sparse-6.png similarity index 100% rename from internal/assets/sparse-6.png rename to .github/images/sparse-6.png diff --git a/internal/assets/sparse-none.png b/.github/images/sparse-none.png similarity index 100% rename from internal/assets/sparse-none.png rename to .github/images/sparse-none.png diff --git a/README.md b/README.md index 982831f4..b7147909 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@

Tile38

@@ -14,11 +14,11 @@ Tile38 is an open source (MIT licensed), in-memory geolocation data store, spati

This README is quick start document. You can find detailed documentation at https://tile38.com.

-Nearby -Within -Intersects -Geofencing -Roaming Geofences +Nearby +Within +Intersects +Geofencing +Roaming Geofences

## Features @@ -134,19 +134,19 @@ To set a field when an object already exists: Tile38 has support to search for objects and points that are within or intersects other objects. All object types can be searched including Polygons, MultiPolygons, GeometryCollections, etc. -Search Within +Search Within #### Within WITHIN searches a collection for objects that are fully contained inside a specified bounding area.
-Search Intersects +Search Intersects #### Intersects INTERSECTS searches a collection for objects that intersect a specified bounding area.
-Search Nearby +Search Nearby #### Nearby NEARBY searches a collection for objects that intersect a specified radius. @@ -157,12 +157,12 @@ NEARBY searches a collection for objects that intersect a specified radius. This is very helpful for example; when you have many (perhaps millions) of objects and do not want them all clustered together on a map. Sparse will limit the number of objects returned and provide them evenly distributed so that your map looks clean.

You can choose a value between 1 and 8. The value 1 will result in no more than 4 items. The value 8 will result in no more than 65536. *1=4, 2=16, 3=64, 4=256, 5=1024, 6=4098, 7=16384, 8=65536.*

- - - - - - + + + + + +
No SparsingSearch WithinSparse 1Search WithinSparse 2Search WithinSparse 3Search WithinSparse 4Search WithinSparse 5Search WithinNo SparsingSearch WithinSparse 1Search WithinSparse 2Search WithinSparse 3Search WithinSparse 4Search WithinSparse 5Search Within
*Please note that the higher the sparse value, the slower the performance. Also, LIMIT and CURSOR are not available when using SPARSE.* @@ -180,7 +180,7 @@ You can choose a value between 1 and 8. The value 1 will result in no more than ## Geofencing -Geofence animation +Geofence animation A geofence is a virtual boundary that can detect when an object enters or exits the area. This boundary can be a radius, bounding box, or a polygon. Tile38 can turn any standard search into a geofence monitor by adding the FENCE keyword to the search. *Tile38 also allows for [Webhooks](https://tile38.com/commands/sethook) to be assigned to Geofences.*