Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ciscorn committed Dec 14, 2024
1 parent 993fe87 commit 87eb13a
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 16 deletions.
26 changes: 15 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
![NPM Version](https://img.shields.io/npm/v/svelte-maplibre-gl)
![NPM License](https://img.shields.io/npm/l/svelte-maplibre-gl?color=96C902)

Use [MapLibre GL JS](https://maplibre.org/maplibre-gl-js/docs/) with the full potential of [Svelte](https://svelte.dev/)'s reactivity.
Simplify [MapLibre GL JS](https://maplibre.org/maplibre-gl-js/docs/) with the full potential of [Svelte](https://svelte.dev/)'s reactivity.

Documentaion and Examples: https://svelte-maplibre-gl.mierune.dev/examples/

Expand All @@ -21,22 +21,26 @@ npm install --dev svelte-maplibre-gl

Licensed under the [MIT License](./LICENSE-MIT.txt) or the [Apache License 2.0](./LICENSE-APACHE.txt), at your option.

## Acknowledgements

This project `svelte-maplibre-gl` is built from scratch, while drawing inspiration from the work of the following libraries:

- [`dimfeld/svelte-maplibre`](https://github.com/dimfeld/svelte-maplibre) — A library offering idiomatic Svelte support for the MapLibre GL mapping software
- [`visgl/react-map-gl`](https://github.com/visgl/react-map-gl) — React friendly API wrapper around Mapbox/MapLibre GL JS

## Contributing

Everyone is welcomed to contribute to this project! There are many ways to support the project, such as:
Everyone is welcome to contribute to this project! There are many ways to support the project, such as:

- Trying it out and reporting any issues or missing features you encounter
- Expanding or improving the examples
- Anything else you can think of!

- TODO
Your contributions are greatly appreciated.

### Authors

- Core maintainers:
- Maintainers:
- Taku Fukada ([@ciscorn](https://github.com/ciscorn/)) - Original Author
- Kanahiro Iguchi ([@Kanahiro](https://github.com/Kanahiro/))
- And [all contributors](https://github.com/MIERUNE/svelte-maplibre-gl/graphs/contributors)

## Acknowledgements

This project `svelte-maplibre-gl` is built from scratch, while drawing inspiration from the work of the following libraries:

- [`dimfeld/svelte-maplibre`](https://github.com/dimfeld/svelte-maplibre) — A library offering idiomatic Svelte support for the MapLibre GL mapping software
- [`visgl/react-map-gl`](https://github.com/visgl/react-map-gl) — React friendly API wrapper around Mapbox/MapLibre GL JS
2 changes: 0 additions & 2 deletions src/lib/components/ui/radio-group/radio-group.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@
value = $bindable(),
...restProps
}: RadioGroupPrimitive.RootProps = $props();
export { className as class };
</script>

<RadioGroupPrimitive.Root bind:value class={cn("grid gap-2", className)} {...restProps} bind:ref />
4 changes: 2 additions & 2 deletions src/lib/utils.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { type ClassValue, clsx } from 'clsx';
import { twMerge } from 'tailwind-merge';
import { type ClassValue, clsx } from "clsx";
import { twMerge } from "tailwind-merge";

export function cn(...inputs: ClassValue[]) {
return twMerge(clsx(inputs));
Expand Down
2 changes: 1 addition & 1 deletion src/routes/+page.svelte
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<div class="mx-auto w-full px-4 py-8 2xl:container md:p-8 md:py-16">
<main class="prose max-w-none dark:prose-invert">
<h1>Svelte MapLibre GL</h1>
<p>Use MapLibre GL JS with the full potential of Svelte's reactivity.</p>
<p>Simplify MapLibre GL JS with the full potential of Svelte's reactivity.</p>
<p>
<a href="/examples/">Examples</a>
</p>
Expand Down

0 comments on commit 87eb13a

Please sign in to comment.