library-mirrors/ftcsv
1
0
Fork 0
mirror of https://github.com/FourierTransformer/ftcsv.git synced 2024-11-19 19:54:23 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

updated to fix bad md formatting

Browse Source
This commit is contained in:
Shakil Thakur 2017-10-07 10:50:41 -05:00 committed by GitHub
parent a94461c347
commit 7d5ac974b0
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -16,7 +16,7 @@ luarocks install ftcsv
## Parsing ## Parsing
###`ftcsv.parse(fileName, delimiter [, options])` ### `ftcsv.parse(fileName, delimiter [, options])`
ftcsv will load the entire csv file into memory, then parse it in one go, returning a lua table with the parsed data. It has only two required parameters - a file name and delimiter (limited to one character). A few optional parameters can be passed in via a table (examples below). ftcsv will load the entire csv file into memory, then parse it in one go, returning a lua table with the parsed data. It has only two required parameters - a file name and delimiter (limited to one character). A few optional parameters can be passed in via a table (examples below).
@ -92,7 +92,8 @@ For all tested examples, take a look in /spec/feature_spec.lua
## Encoding ## Encoding
###`ftcsv.encode(inputTable, delimiter[, options])` ### `ftcsv.encode(inputTable, delimiter[, options])`
ftcsv can also take a lua table and turn it into a text string to be written to a file. It has two required parameters, an inputTable and a delimiter. You can use it to write out a file like this: ftcsv can also take a lua table and turn it into a text string to be written to a file. It has two required parameters, an inputTable and a delimiter. You can use it to write out a file like this:
```lua ```lua
local fileOutput = ftcsv.encode(users, ",") local fileOutput = ftcsv.encode(users, ",")
@ -124,17 +125,17 @@ ftcsv returns a litany of errors when passed a bad csv file or incorrect paramet
## Contributing ## Contributing
Feel free to create a new issue for any bugs you've found or help you need. If you want to contribute back to the project please do the following: Feel free to create a new issue for any bugs you've found or help you need. If you want to contribute back to the project please do the following:
0. If it's a major change (aka more than a quick little < 5 line bugfix), please create an issue so we can discuss it! 0. If it's a major change (aka more than a quick bugfix), please create an issue so we can discuss it!
1. Fork the repo 1. Fork the repo
2. Create a new branch 2. Create a new branch
3. Push your changes to the branch 3. Push your changes to the branch
4. Run the test suite and make sure it still works 4. Run the test suite and make sure it still works
5. Submit a pull request 5. Submit a pull request
6. ??? 6. Wait for review
7. Enjoy the changes made to the repo! 7. Enjoy the changes made!
## Licenses ## Licenses
- The main library is licensed under the MIT License. Feel free to use it! - The main library is licensed under the MIT License. Feel free to use it!
- Some of the test CSVs are from [csv-spectrum](https://github.com/maxogden/csv-spectrum) (BSD-2-Clause) which includes some from [csvkit](https://github.com/wireservice/csvkit) (MIT License) - Some of the test CSVs are from [csv-spectrum](https://github.com/maxogden/csv-spectrum) (BSD-2-Clause) which includes some from [csvkit](https://github.com/wireservice/csvkit) (MIT License)