This is an automated email from the ASF dual-hosted git repository.
adrabble pushed a commit to branch 549-improve-the-readme
in repository https://gitbox.apache.org/repos/asf/incubator-baremaps.git
The following commit(s) were added to refs/heads/549-improve-the-readme by this
push:
new 36b3e597 Update README.md
36b3e597 is described below
commit 36b3e59799462ef13e04c74043a8284ee8e5c6ac
Author: Antoine Drabble <[email protected]>
AuthorDate: Tue Dec 6 20:02:00 2022 +0100
Update README.md
---
README.md | 70 ++++++++++++++++++++++++++++++++++++++-------------------------
1 file changed, 42 insertions(+), 28 deletions(-)
diff --git a/README.md b/README.md
index 44af1bad..65b94fa3 100644
--- a/README.md
+++ b/README.md
@@ -1,38 +1,52 @@
-# 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.
+
+- [Install the Baremaps
CLI](https://baremaps.apache.org/examples/openstreetmap/)
+- [Import OSM data from GeoFabrik into
PostGIS](https://baremaps.apache.org/examples/openstreetmap/)
+- [Import Natural Earth data into
PostGIS](https://baremaps.apache.org/examples/openstreetmap/)
+- [Import Contour lines from the ASTER dataset into
PostGIS](https://baremaps.apache.org/examples/openstreetmap/)
+- [Serve Mapbox Vector Tiles from
PostGIS](https://baremaps.apache.org/examples/openstreetmap/)
+- [Generate and serve a geocoding
index](https://baremaps.apache.org/examples/openstreetmap/)
+- [Generate and serve an IP to location
index](https://baremaps.apache.org/examples/openstreetmap/)
+
+## 👩💻 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.
-[](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).
+- [How to build with Maven](https://baremaps.apache.org/development/build/)
+- [How to run in IntelliJ](https://baremaps.apache.org/development/run/)
+- [Structure and modules](https://baremaps.apache.org/development/run/)
-[](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
