iv-org-mirror
/
shard-backtracer.cr
mirror of https://gitea.invidious.io/iv-org/shard-backtracer.cr.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README

This commit is contained in:
Sijawusz Pur Rahnama 2020-12-28 21:19:23 +01:00
parent 6a5100dc61
commit 4f085e1f1e
1 changed files with 30 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@ -1,6 +1,6 @@
# backtracer.cr
# backtracer.cr [![Build Status](https://travis-ci.com/Sija/backtracer.cr.svg?branch=master)](https://travis-ci.com/Sija/backtracer.cr) [![Releases](https://img.shields.io/github/release/Sija/backtracer.cr.svg)](https://github.com/Sija/backtracer.cr/releases) [![License](https://img.shields.io/github/license/Sija/backtracer.cr.svg)](https://github.com/Sija/backtracer.cr/blob/master/LICENSE)
TODO: Write a description here
Crystal shard aiming to assist with parsing backtraces into a structured form.
## Installation
@ -18,14 +18,36 @@ TODO: Write a description here
```crystal
require "backtracer"
def foo
raise "bang!"
end
def bar
foo
end
def baz
bar
end
begin
baz
rescue ex
backtrace = Backtracer.parse(ex.backtrace)
# Prints
#
# `foo` at foo.cr:4:3
# `bar` at foo.cr:8:3
# `baz` at foo.cr:12:3
# ...
backtrace.frames.each do |frame|
puts frame
end
end
```
TODO: Write usage instructions here
## Development
TODO: Write development instructions here
## Contributing
1. Fork it (<https://github.com/Sija/backtracer.cr/fork>)