Skip to content

Commit

Permalink
docs: refactor TODOs and README
Browse files Browse the repository at this point in the history
  • Loading branch information
davidjrice committed Apr 4, 2024
1 parent 283b6c7 commit 950df03
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 10 deletions.
2 changes: 1 addition & 1 deletion README.mdown → README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ ATCO-CIF is the format of choice for UK public transport authorities. This is a

### USAGE

Currently this library is under-development and has several things left to do before it is perfect (see the [todo.mdown](http://github.com/davidjrice/atco/blob/master/todo.mdown) list ).
Currently this library is under-development and has several things left to do before it is perfect (see the [todo.md](http://github.com/davidjrice/atco/blob/master/TODO.md) list ).

* clone this library
* start an irb session
Expand Down
17 changes: 10 additions & 7 deletions todo.mdown → TODO.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,21 @@
## TODO

### Version (0.0.3)
### Version (future)

* Remove data from the repo / gem **(DONE)**
* If nil or blank data found. Remove from output
* Specs should not test the internal methods, should retrieve the objects to test from Atco.parse !!
* Parse all objects into more native ruby objects
* Header attributes should just be root attrs
* "Models" are getting quite repetitive/declarative, declarative is good to allow for easy (understandable) mapping to better domain... however, use active model?
* Handle translink atco-cif extensions during parsing
* handle bank holiday parsing

### Version (1.0.0)

* Update to Ruby 3.x.x compatibility
* Remove deprecated code
* Update docs

### Version (0.0.2)

Expand All @@ -30,9 +39,3 @@
* Journey header not integrated into output **(DONE)**
* Location data should be combined **(DONE)**
* Gemify the library **(DONE)**

### Nice-to-have

* "Models" are getting quite repetitive/declarative, declarative is good to allow for easy (understandable) mapping to better domain... however, use active model?
* Handle translink atco-cif extensions during parsing
* handle bank holiday parsing
4 changes: 2 additions & 2 deletions atco.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ Gem::Specification.new do |s|
s.license = 'MIT'
s.authors = ['David Rice']
s.email = '[email protected]'
s.files = s.files = Dir['{lib,spec}/**/*', 'README.mdown', 'Rakefile', 'VERSION']
s.files = s.files = Dir['{lib,spec}/**/*', 'README.md', 'Rakefile', 'VERSION']
s.extra_rdoc_files = [
'README.mdown'
'README.md'
]
s.rdoc_options = ['--charset=UTF-8']
s.require_paths = ['lib']
Expand Down

0 comments on commit 950df03

Please sign in to comment.