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.

Sign up for GitHub

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

Jump to bottom

Update README #59

Open
JustinMShea opened this issue Sep 4, 2021 · 1 comment
Open

Update README #59

JustinMShea opened this issue Sep 4, 2021 · 1 comment
Assignees
@JustinMShea @martinrd3D
Labels
bug enhancement

Comments

@JustinMShea
Copy link
Collaborator

The current README has good information, but could benefit from an improved layout, instructions, and content edits. These include but aren't limited to

  • Adding relevant badges which communicate various status to the user
  • Edit and expand install instructions if needed.
  • Update and double check data sources
  • A few examples to get folks started right away
JustinMShea added a commit that referenced this issue Sep 4, 2021
@JustinMShea
#59 Formatting layout, added link to vignette
f90c474
JustinMShea added a commit that referenced this issue Sep 4, 2021
@JustinMShea
#59 updated install instructions and minor formatting.
3432175
JustinMShea added a commit that referenced this issue Sep 4, 2021
@JustinMShea
#59 hyperlinked the open issues preventing install with the remotes p…
18ace1f 
…ackage
JustinMShea added a commit that referenced this issue Sep 4, 2021
@JustinMShea
#59 minor edits for clarity
90c2886
JustinMShea added a commit that referenced this issue Sep 26, 2021
@JustinMShea
#59 moving install instructions up.
986d8a6
@JustinMShea
Copy link
Collaborator Author

Add notes on broader vision for this package and define it by acknowledging the decade long effort of many contributors to add their work to this repo, which is essentially a collection of functions for factor modeling

@JustinMShea JustinMShea mentioned this issue Dec 24, 2021
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@JustinMShea JustinMShea

@martinrd3D martinrd3D

Labels
bug enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@JustinMShea @martinrd3D