@xivstats/lodestone

Module for pulling character profiles from the Final Fantasy XIV Lodestone

Usage no npm install needed!

<script type="module">
  import xivstatsLodestone from 'https://cdn.skypack.dev/@xivstats/lodestone';
</script>

README

Lodestone by XIVStats

NPM version Build, Test & Lint codecov GitHub license npm downloads

Lodestone is a module for interfacing with the Final Fantasy XIV Lodestone, and returning entity (character, server etc.) information.


Jump To: API Reference | Getting Started | Contributing

Getting-Started

1. Installation

npm install --save @xivstats/lodestone

or if you're using yarn

yarn install @xivstats/lodestone

2. Imports

TODO

Contributing

We welcome community contributions and pull requests. See CONTRIBUTING.md for information on how to set up a development environment and submit code.

More resources