Merge pull request #41 from binary-butterfly/modernize

Rework everything

.github/workflows/build.yml

@@ -16,7 +16,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: 22
           cache: 'npm'
       - run: npm install
       - run: npm run build:prod

.github/workflows/release.yml

@@ -10,7 +10,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: 22
       - run: npm install
       - run: npm run prepublishOnly
       - uses: JS-DevTools/npm-publish@v2

README.md

@@ -1,62 +1,20 @@
 # ReactButterflyMap
 
-This is a small react component that contains an OpenStreetMap widget with points of interest .
+This is a small react component that contains an OpenStreetMap widget with points of interest.
 
 ## Current state
 
-This library is working as intended but still pre- 1.0 release, meaning that the API may change at any moment
-or that new features might not always be entirely documented.  
+After not being updated for almost exactly three years, this library got almost completely rewritten to make it more adaptable,
+improve its code style, DX, and make everything better.  
+I have not yet written documentation about the changes to how the library works, but I hope to do so soon.
+Once I am done, this will be the 1.0.0 release of the library.
 
 ## How to use
 
 * Install the package: `npm install react-butterfly-map `
 * Import the main component: `import ButterflyMap from 'react-butterfly-map'`
-* Include the component in you code similar to this example:
-   ```js
-   <ButterflyMap
-                tileServer={'your.tile-server.invalid.tld/style.json'}
-                center={{latitude: 47.79, longitude: 13.0550}}
-                height={500}
-                pointTypes={[
-                    {
-                        name: 'Example 1',
-                        icon: YourIconReactComponent,
-                        points: [
-                            {
-                                position: {latitude: 47.850670, longitude: 13.090983},
-                                address: 'Street 123, Somewhere',
-                                text: 'This is an example',
-                                additionalInfo: 'Examples are used to to show how something works.',
-                                hours: {
-                                    sunday: false,
-                                    monday: [{from: ['7', '0'], until: ['22', '0']}],
-                                    tuesday: [{from: ['20', '0'], until: ['22', '0']}],
-                                    wednesday: [{from: ['7', '0'], until: ['22', '0']}],
-                                    thursday: [{from: ['7', '0'], until: ['22', '0']}],
-                                    friday: [{from: ['7', '0'], until: ['22', '0']}],
-                                    saturday: false,
-                                },
-                                valid: {
-                                    from: '2021-01-01',
-                                    until: '2038-01-01',
-                                }
-                            },
-                        ],
-                    },
-                ]}
-            />
-   ```
 
-### Searching
-
-There is some (currently untested) search functionality available.  
-To use this, you must set up a server that responds to a JSON call containing the key `searchString` with an array
-of position objects containing the keys `text`, `latitude` and `longitude`.
-
-Once you've done that, simply set the `searchBackend` param of `<ButterflyMap/>` to the URL of your backend.
-
-This feature is still in early development and the API may change.  
-Due to the cost associated with Geocoding, there is no search backend available for testing at this time.
+TODO: Write docs for this. But not in the middle of the night on a sunday.
 
 ## Development