Contents

# K Doc

> KDoc provides a document in the form a DSL that contains flexible key/value and tabular data

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'k_doc'
```

And then execute:

```bash
bundle install
```

Or install it yourself as:

```bash
gem install k_doc
```

## Stories

### Main Story

As a Developer, I need flexible data structures defined in DSL, so can model rich documents

See [project plan](./docs/project-plan.md)


## Usage

See all [usage examples](./USAGE.md)

### Basic Example

#### Basic example

Description for a basic example to be featured in the main README.MD file

```ruby
class SomeRuby; end
```

## Development

Checkout the repo

```bash
git clone klueless-io/k_doc
```

`k_doc` is setup with Guard, run `guard`, this will watch development file changes and run tests automatically, if successful, it will then run rubocop for style quality.

To release a new version, update the version number in `version.rb`, build the gem and push the `.gem` file to [rubygems.org](https://rubygems.org).

```bash
rake publish
rake clean
```

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/klueless-io/k_doc. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

## Code of Conduct

Everyone interacting in the K Doc project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/klueless-io/k_doc/blob/master/CODE_OF_CONDUCT.md).

## Copyright

Copyright (c) David Cruwys. See [MIT License](LICENSE.txt) for further details.

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
k_doc-0.0.38	README.md
k_doc-0.0.37	README.md
k_doc-0.0.36	README.md
k_doc-0.0.35	README.md