Skip to content

Commit 8b47276

Browse files
committed
Update README and docs
1 parent f76afd1 commit 8b47276

File tree

7 files changed

+158
-9
lines changed

7 files changed

+158
-9
lines changed

README.md

Lines changed: 50 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,57 @@
1-
SQLite.jl
2-
=========
1+
# SQLite
32

4-
[![SQLite](http://pkg.julialang.org/badges/SQLite_0.3.svg)](http://pkg.julialang.org/?pkg=SQLite)
5-
[![SQLite](http://pkg.julialang.org/badges/SQLite_0.4.svg)](http://pkg.julialang.org/?pkg=SQLite)
6-
[![Build Status](https://travis-ci.org/JuliaDB/SQLite.jl.svg?branch=master)](https://travis-ci.org/JuliaDB/SQLite.jl)
7-
[![Coverage Status](https://coveralls.io/repos/JuliaDB/SQLite.jl/badge.svg?branch=master&service=github)](https://coveralls.io/github/JuliaDB/SQLite.jl?branch=master)
3+
*A fast, flexible delimited file reader/writer for Julia.*
84

9-
A Julia interface to the SQLite library and support for the `DataStreams` data processing framework.
5+
| **Documentation** | **PackageEvaluator** | **Build Status** |
6+
|:-------------------------------------------------------------------------------:|:---------------------------------------------------------------:|:-----------------------------------------------------------------------------------------------:|
7+
| [![][docs-stable-img]][docs-stable-url] [![][docs-latest-img]][docs-latest-url] | [![][pkg-0.4-img]][pkg-0.4-url] [![][pkg-0.5-img]][pkg-0.5-url] | [![][travis-img]][travis-url] [![][appveyor-img]][appveyor-url] [![][codecov-img]][codecov-url] |
108

11-
**Note: the package has recently undergone major UI changes: for 0.3 compatible code, please see the old [README](https://github.com/JuliaDB/SQLite.jl/blob/master/OLD_README.md)
129

13-
**Installation**: `julia> Pkg.add("SQLite")`
10+
## Installation
11+
12+
The package is registered in `METADATA.jl` and so can be installed with `Pkg.add`.
13+
14+
```julia
15+
julia> Pkg.add("SQLite")
16+
```
17+
18+
## Documentation
19+
20+
- [**STABLE**][docs-stable-url] — **most recently tagged version of the documentation.**
21+
- [**LATEST**][docs-latest-url] — *in-development version of the documentation.*
22+
23+
## Project Status
24+
25+
The package is tested against Julia `0.4` and *current* `0.5-dev` on Linux, OS X, and Windows.
26+
27+
## Contributing and Questions
28+
29+
Contributions are very welcome, as are feature requests and suggestions. Please open an
30+
[issue][issues-url] if you encounter any problems or would just like to ask a question.
31+
32+
33+
34+
[docs-latest-img]: https://img.shields.io/badge/docs-latest-blue.svg
35+
[docs-latest-url]: https://JuliaDB.github.io/SQLite.jl/latest
36+
37+
[docs-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg
38+
[docs-stable-url]: https://JuliaDB.github.io/SQLite.jl/stable
39+
40+
[travis-img]: https://travis-ci.org/JuliaDB/SQLite.jl.svg?branch=master
41+
[travis-url]: https://travis-ci.org/JuliaDB/SQLite.jl
42+
43+
[appveyor-img]: https://ci.appveyor.com/api/projects/status/h227adt6ovd1u3sx/branch/master?svg=true
44+
[appveyor-url]: https://ci.appveyor.com/project/JuliaDB/documenter-jl/branch/master
45+
46+
[codecov-img]: https://codecov.io/gh/JuliaDB/SQLite.jl/branch/master/graph/badge.svg
47+
[codecov-url]: https://codecov.io/gh/JuliaDB/SQLite.jl
48+
49+
[issues-url]: https://github.com/JuliaDB/SQLite.jl/issues
50+
51+
[pkg-0.4-img]: http://pkg.julialang.org/badges/SQLite_0.4.svg
52+
[pkg-0.4-url]: http://pkg.julialang.org/?pkg=SQLite
53+
[pkg-0.5-img]: http://pkg.julialang.org/badges/SQLite_0.5.svg
54+
[pkg-0.5-url]: http://pkg.julialang.org/?pkg=SQLite
1455

1556
## Package Documentation
1657

docs/.documenter.enc

1.64 KB
Binary file not shown.

docs/build/assets/Documenter.css

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
div.wy-menu-vertical ul.current li.toctree-l3 a {
2+
font-weight: bold;
3+
}
4+
5+
a.documenter-source {
6+
float: right;
7+
}
8+
9+
.documenter-methodtable pre {
10+
margin-left: 0px;
11+
margin-right: 0px;
12+
margin-top: 0px;
13+
padding: 0px;
14+
}
15+
16+
.documenter-methodtable pre.documenter-inline {
17+
display: inline;
18+
}

docs/build/assets/mathjaxhelper.js

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
MathJax.Hub.Config({
2+
"tex2jax": {
3+
inlineMath: [['$','$'], ['\\(','\\)']],
4+
processEscapes: true
5+
}
6+
});
7+
MathJax.Hub.Config({
8+
config: ["MMLorHTML.js"],
9+
jax: [
10+
"input/TeX",
11+
"output/HTML-CSS",
12+
"output/NativeMML"
13+
],
14+
extensions: [
15+
"MathMenu.js",
16+
"MathZoom.js",
17+
"TeX/AMSmath.js",
18+
"TeX/AMSsymbols.js",
19+
"TeX/autobold.js",
20+
"TeX/autoload-all.js"
21+
]
22+
});
23+
MathJax.Hub.Config({
24+
TeX: { equationNumbers: { autoNumber: "AMS" } }
25+
});

docs/build/index.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
2+
<a id='SQLite.jl-Documentation-1'></a>
3+
4+
# SQLite.jl Documentation
5+
6+
- [SQLite.jl Documentation](index.md#SQLite.jl-Documentation-1)
7+
- [High-level interface](index.md#High-level-interface-1)
8+
- [Lower-level utilities](index.md#Lower-level-utilities-1)
9+
10+
11+
<a id='High-level-interface-1'></a>
12+
13+
## High-level interface
14+
15+
16+
```
17+
SQLite.read
18+
SQLite.write
19+
```
20+
21+
22+
<a id='Lower-level-utilities-1'></a>
23+
24+
## Lower-level utilities
25+
26+
27+
```
28+
SQLite.Source
29+
SQLite.Sink
30+
SQLite.Options
31+
SQLite.parsefield
32+
SQLite.readline(::SQLite.Source)
33+
SQLite.readsplitline
34+
SQLite.countlines(::SQLite.Source)
35+
```
36+

docs/mkdocs.yml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
site_name: SQLite.jl
2+
repo_url: https://github.com/JuliaDB/SQLite.jl
3+
site_description: SQLite library for Julia
4+
site_author: Jacob Quinn
5+
6+
theme: material
7+
8+
extra:
9+
palette:
10+
primary: 'indigo'
11+
accent: 'blue'
12+
13+
extra_css:
14+
- assets/Documenter.css
15+
16+
extra_javascript:
17+
- https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML
18+
- assets/mathjaxhelper.js
19+
20+
markdown_extensions:
21+
- extra
22+
- tables
23+
- fenced_code
24+
- mdx_math
25+
26+
docs_dir: 'build'
27+
28+
pages:
29+
- Home: index.md
File renamed without changes.

0 commit comments

Comments
 (0)