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 note for mandatory "attach" call to README (for typescript) #115

Open
rala72 opened this issue Mar 28, 2024 · 1 comment
Open

Add note for mandatory "attach" call to README (for typescript) #115

rala72 opened this issue Mar 28, 2024 · 1 comment

Comments

@rala72
Copy link

rala72 commented Mar 28, 2024

General information

  • Library version: 5.0.0+ (now 6.0.0)
  • Typescript: 5.1.6
  • Angular 16.2.12/14

Issue description

I was upgrading from 2.0.5 and wondered several hours of debugging why it didn't work anymore.
Narrowed it down to the 4.x to 5.x change.
IntelliJ only let me import framebus via import {Framebus} from 'framebus/dist/framebus';
So, I was obviously missing the mandatory attach() call done in index.ts.

I want therefore to request a note in README.md to either add an additional line import 'framebus/dist/index'; or alternativly call attach() in dist/lib/attach directly.
This might prevent some frustration other users might have.

Thank you.

Sidenote - I found some typos in the README: conjuction, succesfully, refrence

@rala72 rala72 changed the title Add mandatory "attach" call to README (for typescript) Add note for mandatory "attach" call to README (for typescript) Mar 28, 2024
@jplukarski
Copy link
Contributor

@rala72 thanks for pointing these things out to us. We've made a ticket in our backlog to cleanup the README with your suggestions. For internal tracking -> 118

If you'd like, you can also open a PR with these changes for us to review.

We'l leave this issue open until we're able to make these updates.

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

No branches or pull requests

2 participants