From 8527a5ba0ff2c09317fca8a98a91f890e43df06a Mon Sep 17 00:00:00 2001
From: Guilhem Lavaux <guilhem.lavaux@iap.fr>
Date: Sat, 2 Nov 2024 11:34:29 +0200
Subject: [PATCH] feat: Add example

BREAKING CHANGE. This should be the initial release.
---
 README.md | 22 +++++++++++++++++++++-
 1 file changed, 21 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 1232ce9..420165b 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,22 @@
-This is pysphereproj
+# PySphereProj
 
+This is a simple package made of 3d interpolators (CIC based) and 3d to healpix projector.
+
+Everything is contained in the package `sphereproj`.
+
+Here is a short example for spherical projection:
+
+```python
+
+import sphereproj
+import numpy as np
+
+N = 256
+Nside=128
+rho = np.random.randn(N,N,N)
+
+result = sphereproj.spherical_projection(Nside, density, 0, 128, integrator_id=1)
+# min_distance, max_distance, progress=1, integrator_id=0, shifter=None, booster=-1)
+
+
+```