This is an automated email from the ASF dual-hosted git repository.
adrabble pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-baremaps.git
The following commit(s) were added to refs/heads/main by this push:
new b7f2bd53 Update README.md (#550)
b7f2bd53 is described below
commit b7f2bd53d16678a8855638f5b384a687dbefe741
Author: Antoine Drabble <[email protected]>
AuthorDate: Thu Dec 8 14:48:02 2022 +0100
Update README.md (#550)
* Update README.md
* Add link to the website repository in the README
* Fix links to documentation in README.md
---
README.md | 73 +++++++++++++++++++++++++++++++++++++++------------------------
1 file changed, 45 insertions(+), 28 deletions(-)
diff --git a/README.md b/README.md
index 44af1bad..a7fecfb4 100644
--- a/README.md
+++ b/README.md
@@ -1,38 +1,55 @@
-# Baremaps
+<div align="center">
+<br/>
+<img src="logo.svg" width="100px">
-
+# Apache Baremaps (Incubating)
-
-
-
-
-[](https://sonarcloud.io/dashboard?id=baremaps_baremaps)
-[](https://sonarcloud.io/dashboard?id=baremaps_baremaps)
-[](https://sonarcloud.io/dashboard?id=baremaps_baremaps)
-[](https://sonarcloud.io/dashboard?id=baremaps_baremaps)
-[](https://sonarcloud.io/dashboard?id=baremaps_baremaps)
-[](https://sonarcloud.io/dashboard?id=baremaps_baremaps)
+[](http://makeapullrequest.com)
+
[](https://sonarcloud.io/dashboard?id=baremaps_baremaps)
-[](https://sonarcloud.io/dashboard?id=baremaps_baremaps)
-[](https://sonarcloud.io/dashboard?id=baremaps_baremaps)
-[](https://sonarcloud.io/dashboard?id=baremaps_baremaps)
-[](https://sonarcloud.io/dashboard?id=baremaps_baremaps)
+[](https://lists.apache.org/[email protected])
+
+</div>
+
+**Apache Baremaps** is a toolkit and a set of infrastructure components for
creating, publishing, and operating online maps. It provides a data pipeline
enabling developers to build maps with different data sources with live reload
capabilities. It provides other services commonly used in online maps, such as
location search and IP to location.
+
+## 🔥 Live Demo
+
+[https://demo.baremaps.com/](https://demo.baremaps.com/)
+
+## 📖 How do I use Apache Baremaps?
+
+You can find the official documentation at
[https://baremaps.apache.org/](https://baremaps.apache.org/). The following
pages showcase the main uses of Apache Baremaps.
+
+- The [OpenStreetMap](/examples/import-osm-into-postgis/) example is a good
introduction to Baremaps, it shows how to produce high resolution vector tiles.
+- The [NaturalEarth](/examples/import-naturalearth-into-postgis/) example
shows how to produce low resolution vector tiles.
+- The [Contour](/examples/import-contour-into-postgis/) example shows how to
produce contour lines from a digital elevation model.
+- The [IP to location](/examples/ip-to-location/) example shows how to create
and serve an IP to location service in a simple web application.
+- The [Geocoding](/examples/geocoding/) example shows how to create and serve
a geocoding service in a simple web application.
+
+## 👩💻 How do I contribute?
+
+There are many places where you can contribute to Apache Baremaps such as the
code, the documentation, the website or the examples.
+
+The official documentation is located in a separate repository available here
[https://github.com/apache/incubator-baremaps-site](https://github.com/apache/incubator-baremaps-site).
-[](https://opensource.org/licenses/Apache-2.0)
-[](https://app.fossa.io/projects/git%2Bgithub.com%2Fbaremaps%2Fbaremaps?ref=badge_shield)
+If you want to contribute to the code you can refer to the following developer
guides available in the documentation.
-[Baremaps](https://www.baremaps.com/) is a toolkit for creating custom vector
tiles from [OpenStreetMap](https://www.openstreetmap.org) and other data
sources with Postgis and Java. The project is licensed under [Apache License
2.0](LICENSE).
+- [Project structure](/developer-manual/project-structure/)
+- [How to build with Maven](/developer-manual/how-to-build-with-maven/)
+- [Set up in IntelliJ IDEA](/developer-manual/setup-with-intellij/)
+- [Geocoder](/developer-manual/geocoder/)
+- [IP to location](/developer-manual/ip-to-location/)
+- [Stylesheet](/developer-manual/stylesheet/)
-[](https://www.baremaps.com/assets/demo.html)
+You can also contribute in the following ways.
-Baremaps is inspired by [Osmosis](https://github.com/openstreetmap/osmosis),
but it comes with additional features, such as the ability to:
-- Process data in parallel with the [Stream
API](https://docs.oracle.com/javase/8/docs/api/java/util/stream/package-summary.html)
introduced in Java 8
-- Import data faster with the [COPY
API](https://www.postgresql.org/docs/11/sql-copy.html) of Postgresql
-- Create postgis geometries on the fly with
[JTS](https://github.com/locationtech/jts)
-- Create and serve customized [Mapbox Vector
Tiles](https://docs.mapbox.com/vector-tiles/specification/)
+- [Create an issue](https://github.com/apache/incubator-baremaps/issues):
Report a bug or feature request
+- [Join the mailing
list](https://lists.apache.org/[email protected]): Initiate or
participate in project discussions on the mailing list
+- [Write a post](https://medium.com/): Write a post to share your use cases
and experiences with Apache Baremaps
-On the longer run, the aim of the project is to work with a variety of data
sources in order to create highly specialized and customized maps.
+Finally, check out [CONTRIBUTING](CONTRIBUTING.md) and
[CODE_OF_CONDUCT](CODE_OF_CONDUCT.md).
-## Start Hacking
+## 📄 License
-To contribute to this repo see [CONTRIBUTING](CONTRIBUTING.md) and
[CODE_OF_CONDUCT](CODE_OF_CONDUCT.md).
+This project is licensed under Apache License 2.0 - see the [LICENSE](LICENSE)
file for details.
\ No newline at end of file
