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

Improve README with installation instructions and basic description #20

Open
iainjreid opened this issue Jan 14, 2021 · 0 comments
Open
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@iainjreid
Copy link
Member

The old project icon needs to be removed, installation instructions added, and a short description about the rules used written up. It's also worth documenting that TSLint is officially deprecated, and this package should only really be used until ESLint has full support for TypeScript.

@iainjreid iainjreid added the documentation Improvements or additions to documentation label Jan 14, 2021
@iainjreid iainjreid self-assigned this Jan 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant