semantic_linefeeds 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9a2e3ae8e3a4cde6618c4b0b2c5e3bae2b6a53d3
-  data.tar.gz: 11cfc36682b0aff77e3e7985f5ed732d018b33e2
+  metadata.gz: b9a38fe473b04e8554705406f743b12dd84ce1b3
+  data.tar.gz: 492bad94f8636402aa02f50b481cf32d9ddeaa9d
 SHA512:
-  metadata.gz: f17405fd1a752b74f5b486c9dbe6c05ee0b36551960228906fbd7cd9a7adeac103cf0446821ac96da9b10194a605d780da54720b770f9b7c71d9d83a655c4aec
-  data.tar.gz: 3a3ace871343efbdb7159de23616c40e27ae945279c1f87f25cde59357a5252ec7d967e9e3353273fc4ed2d6ff744587c9a60db282238e947dfb600745a61796
+  metadata.gz: 9a8fa9fed75225100d8b92167b46877b8221bec6a0e7c515dcb4ce1374704700c17ac3bd04dc1c9fdd590f529d49aa64de5005ca0d2ed142de60299c19493284
+  data.tar.gz: d2739666f595765e169d85fbdb89df65390b111402141944f392d4c8544a4ea71c05d6d56a450a2ec3cc2b74843e02bd998c018b8369fae25952b168d83648e3

data/CODE_OF_CONDUCT.md

@@ -1,13 +1,51 @@
 # Contributor Code of Conduct
 
-As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+As contributors and maintainers of this project,
+we pledge to respect all people who contribute through reporting issues,
+posting feature requests,
+updating documentation,
+submitting pull requests or patches,
+and other activities.
 
-We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+We are committed to making participation in this project a harassment-free experience for everyone,
+regardless of level of experience,
+gender,
+gender identity and expression,
+sexual orientation,
+disability,
+personal appearance,
+body size,
+race,
+ethnicity,
+age,
+or religion.
 
-Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+Examples of unacceptable behavior by participants include the use of
+sexual language or imagery,
+derogatory comments or personal attacks,
+trolling,
+public or private harassment,
+insults,
+or other unprofessional conduct.
 
-Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+Project maintainers have the right and responsibility to remove,
+edit,
+or reject comments,
+commits,
+code,
+wiki edits,
+issues,
+and other contributions that are not aligned to this Code of Conduct.
+Project maintainers who do not follow the Code of Conduct
+may be removed from the project team.
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+Instances of abusive,
+harassing,
+or otherwise unacceptable behavior may be reported by opening an issue
+or contacting one or more of the project maintainers.
 
-This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)
+This Code of Conduct is adapted from the
+[Contributor Covenant](http://contributor-covenant.org),
+version 1.0.0,
+available at
+[http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/README.md

@@ -3,7 +3,8 @@
 This is a simple tool to convert text into
 [semantic linefeeds](http://rhodesmill.org/brandon/2012/one-sentence-per-line/).
 
-Rather than having a paragraph formatted as such:
+Rather than having formatting paragraphs to fit an arbitrary line-length,
+like:
 ```
 First, when you do the purely mechanical operations of typing, type so
 subsequent editing will be easy. Start each sentence on a new line. Make lines
@@ -13,7 +14,7 @@ and adding, deleting and rearranging sentences, these precautions simplify any
 editing you have to do later.
 ```
 
-You can write your text like:
+You can add new-lines (er, linefeeds) after each clause and sentence.
 ```
 First,
 when you do the purely mechanical operations of typing,
@@ -29,14 +30,18 @@ these precautions simplify any editing you have to do later.
 ```
 
 This makes `diff`ing it show more information.
-If you're using a text-preprocessor like Markdown,
-this is terrific,
+If you're using Markdown this is terrific,
 since your source can be formatted independently
 of how you display it.
 
 Take a look at the Source of this `README.md` file
 for an example :)
 
+This is just a simple script that breaks lines on certain punctuation marks.
+We aim for the output to be good starting point
+to convert your text to semantic linefeeds,
+rather than attempt to do it automatically 100% correct.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -76,8 +81,10 @@ do you?
 ```
 
 ### File name example
-`echo "Hello, I like this gem. Do you?" > tmp.txt`
-`semantic-linefeeds tmp.txt`
+````
+echo "Hello, I like this gem. Do you?" > tmp.txt`
+semantic-linefeeds tmp.txt
+```
 
 will output:
 ```
@@ -88,12 +95,12 @@ do you?
 
 Note that output currently only goes to STDOUT.
 
-If you try to do something like
+If you try to do something like:
 ```
 semantic-linefeeds README.md > README.md
 ```
 You'll end up with a blank file,
-because the `>` clears the `README.md` file
+because the `>` clears the `README.md` file (for writing)
 before it can be read into memory.
 
 We assume you're using git,
@@ -102,9 +109,9 @@ in case of errors.
 
 ## TODO:
 
-[ ] - Add words to break on ('or, 'and', 'then')
-[ ] - Allow user defined words to break on, probably via a YAML config file
-[ ] - Allow writing results to a file, rather than only to STDOUT.
+- [x] Add words to break on ('or, 'and', 'then')
+- [ ] Allow user defined words to break on, probably via a YAML config file
+- [ ] Allow writing results to a file, rather than only to STDOUT.
 
 ## Development
 

data/lib/semantic_linefeeds/converter.rb

@@ -17,6 +17,9 @@ module SemanticLinefeeds
       (
       \[
       http
+      and
+      or
+      then
     ].freeze
 
     def self.run(text)

data/lib/semantic_linefeeds/version.rb

@@ -1,3 +1,3 @@
 module SemanticLinefeeds
-  VERSION = "0.1.1".freeze
+  VERSION = "0.2.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: semantic_linefeeds
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Sean Collins
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-26 00:00:00.000000000 Z
+date: 2016-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler