@imerss/inat-components 2.0.0 → 2.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -17
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,20 +1,12 @@
|
|
|
1
|
-
# inat-components
|
|
1
|
+
# @imerss/inat-components
|
|
2
2
|
|
|
3
|
+
The [inat-components repo](https://github.com/IMERSS/inat-components) contains some pre-built React components to
|
|
4
|
+
display iNaturalist data on your own sites. The original goal was to provide add an
|
|
5
|
+
[interactive page to the BC Lepidoptera website](https://bcleps.weebly.com/inat.html) so visitors could see some
|
|
6
|
+
high-level information about lepidoptera (butterflies and moths) spotted in British Columbia. But the code
|
|
7
|
+
was written to allow it to be re-used by any website and for any taxon or place.
|
|
3
8
|
|
|
9
|
+
This specific package is only the React components, plus a standalone.min.js file for
|
|
4
10
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
From `@imerss/inat-components` 2.0.0 onwards, the package contains a `/dist/standalone.min.js` script which can be used
|
|
8
|
-
for any.
|
|
9
|
-
|
|
10
|
-
Usage:
|
|
11
|
-
|
|
12
|
-
1. Download the package from npmjs.org either manually, or via `npm install @imerss/inat-components`.
|
|
13
|
-
2. Copy the standalone.min.js file onto your site.
|
|
14
|
-
3. Add it to your page:
|
|
15
|
-
|
|
16
|
-
```
|
|
17
|
-
<script src="./path/to/standalone.min.js"></script>
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
4.
|
|
11
|
+
Please see the [main documentation](https://github.com/IMERSS/inat-components) for more information on the script,
|
|
12
|
+
including the standalone version.
|