update README

jcubic · Jan 17, 2024 · b7c40f4 · b7c40f4
1 parent 18b39bb
commit b7c40f4
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -309,9 +309,21 @@ Links which point to the LIPS website for SEO purpose
 - [ ] [KISS](https://github.com/jcubic/kiss) (chrome extension REPL).
 - [ ] [SMILE](https://github.com/jcubic/smile) (Web IDE), need to start over.
 
+## How you can help
+
+I'm working on version 1.0. If you find any bugs you can help by reporting them.
+If you have some Scheme code that doesn't work (note about the limitations)
+don't hesitate to [report an issue](https://github.com/jcubic/lips/issues/new).
+
+If you enjoy the library you can write about it in a blog post and share information about it or write on Social Media.
+Don't forget to link to the project website (it's
+[good for SEO](https://itnext.io/seo-for-open-source-projects-1a6b17ffeb8b)).
+
+Of course, if you want you can also contribute with code, but there are way easier ways to help. 
+
 ## Acknowledgments
 * Font used in logo is [Telegrafico](https://www.dafont.com/telegrafico.font) by [ficod](https://www.deviantart.com/ficod).
-* Current parser is inspired by implementation in [BiwaScheme](https://www.biwascheme.org/) by Yutaka HARA (yhara).
+* Current Parser is inspired by implementation in [BiwaScheme](https://www.biwascheme.org/) by Yutaka HARA (yhara).
 * `fetch` polyfill use [unfetch](https://github.com/developit/unfetch) by Jason Miller.
 * Browser `init` function use [ContentLoaded](http://javascript.nwbox.com/ContentLoaded/).
 * The rationalize algorithm is based on [Kawa Scheme](https://www.gnu.org/software/kawa/index.html) by Per M.A. Bothner, Alan Bawden and Marc Feeley.

diff --git a/templates/README.md b/templates/README.md
@@ -309,9 +309,21 @@ Links which point to the LIPS website for SEO purpose
 - [ ] [KISS](https://github.com/jcubic/kiss) (chrome extension REPL).
 - [ ] [SMILE](https://github.com/jcubic/smile) (Web IDE), need to start over.
 
+## How you can help
+
+I'm working on version 1.0. If you find any bugs you can help by reporting them.
+If you have some Scheme code that doesn't work (note about the limitations)
+don't hesitate to [report an issue](https://github.com/jcubic/lips/issues/new).
+
+If you enjoy the library you can write about it in a blog post and share information about it or write on Social Media.
+Don't forget to link to the project website (it's
+[good for SEO](https://itnext.io/seo-for-open-source-projects-1a6b17ffeb8b)).
+
+Of course, if you want you can also contribute with code, but there are way easier ways to help. 
+
 ## Acknowledgments
 * Font used in logo is [Telegrafico](https://www.dafont.com/telegrafico.font) by [ficod](https://www.deviantart.com/ficod).
-* Current parser is inspired by implementation in [BiwaScheme](https://www.biwascheme.org/) by Yutaka HARA (yhara).
+* Current Parser is inspired by implementation in [BiwaScheme](https://www.biwascheme.org/) by Yutaka HARA (yhara).
 * `fetch` polyfill use [unfetch](https://github.com/developit/unfetch) by Jason Miller.
 * Browser `init` function use [ContentLoaded](http://javascript.nwbox.com/ContentLoaded/).
 * The rationalize algorithm is based on [Kawa Scheme](https://www.gnu.org/software/kawa/index.html) by Per M.A. Bothner, Alan Bawden and Marc Feeley.