swelshh/wakanda-tsv

Basic tab separated/delimited import function for Wakanda

wakanda-tsv's Issues

Add an example in the readme file

Add a package.json file

to be listed on:
https://github.com/Wakanda-Packages/wakanda-modules

Include MIT License text directly in the readme file

For MIT license, as the text is very short, it is common usage to include it directly in the readme file and don't provide a separated file

ex: https://github.com/AMorgaut/wakanda-eventsource

By the way, you may include references section also listing:

• http://en.wikipedia.org/wiki/Tab-separated_values
• http://www.cs.tut.fi/~jkorpela/TSV.html

inappropriate package / repository names

I'd highly recommend you to give your package, then your module, name, the same name than the one of your repository. The name should also be unique enough to prevent conflict it other modules from the community or with an existing module in the user project.

if you feel that require('Wakanda-Tab-Delim-Import') is too long, I would tend to agree
You can rename your repository while there is not yet too much followers (if there is a link on the forum we could edit the post and fix the link)

it looks like you intended this module to be a util module inwhich you would add more tools. if you do one like that, I'd recommend you to do it as a seperate package which would include this one as a submodule. your "utl" module would then be like micro framework to which you should give a specific name as:

• "swelshh-utils"
• "swelshh-js"
• "harrisjs"
• "corebitsjs"
  ...

Note that it is a good practice for package / module names to be all lowercase

For this specific package I use the "tsv" accronym. "tsv" stands for "tab separated values" -> http://en.wikipedia.org/wiki/Tab-separated_values

Suggested names could be

• "wakanda-tsv"
• "tsv-import"
• "import-tsv"
• "tsvjs"
• "jstsv"
  ...