Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add better usage instructions to documentation #160

Open
leftbones opened this issue Dec 6, 2021 · 1 comment
Open

Add better usage instructions to documentation #160

leftbones opened this issue Dec 6, 2021 · 1 comment
Labels
enhancement New feature or request

Comments

@leftbones
Copy link

I used JSSS years ago but now that points to this as it's been deprecated.

There doesn't appear to be any clear way to actually install, import, and use this in a standard HTML/Javascript environment. All I'm looking to do is generate scrambles from my main.js, yet attempting to import anything throws all sorts of nonsensical errors.

Please simplify usage for those who can't/don't use NPM.

@leftbones leftbones added the enhancement New feature or request label Dec 6, 2021
@lgarron
Copy link
Member

lgarron commented Dec 22, 2021

Apologies for the delay, I missed the notification for this issue until now.

https://github.com/cubing/jsss#%EF%B8%8F-javascript-solverscrambler-suite-%EF%B8%8F includes this sample snippet:

<script type="module">
  import { randomScrambleForEvent } from "https://cdn.cubing.net/js/cubing/scramble";

  const scramble = await randomScrambleForEvent("333");
  scramble.log();
</script>

https://js.cubing.net/cubing/scramble/ also includes more information.

Is that sufficient for you?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants