everything-core 0.0.1 → 0.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.gitignore +1 -0
- data/README.md +33 -1
- data/everything-core.gemspec +1 -0
- data/lib/everything/version.rb +1 -1
- data/lib/everything.rb +3 -0
- metadata +15 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 5a17687cc66c5c0c99821b775eee107ab0425b27
|
4
|
+
data.tar.gz: 56dc019b950f486d68f68ddbf38f7e8f4218e495
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 8681ba9e53c5bce59cb520bcb943dfd8a688d4f9cb3d3e8198ac22fd2f5aef7cc69746fd0993fc234f2f63ab97099f61bb57b082b4ed353efee6350aec0ab172
|
7
|
+
data.tar.gz: ffab10e88a2fcf7d2de8a680ebbc360b2acb67a8b8d19046b55bc5109f8eded6ca754fb4219da86ebed4d10059e0f69554db2f470b1a8cd95a817270d27b6836
|
data/.gitignore
CHANGED
data/README.md
CHANGED
@@ -1,5 +1,8 @@
|
|
1
1
|
# everything-core
|
2
2
|
|
3
|
+
For familiarity with a `everything` repository, see the
|
4
|
+
[intro](http://blog.kyletolle.com/introducing-everything/).
|
5
|
+
|
3
6
|
The piece is the most important concept of everything. This is the core for
|
4
7
|
everything, and other pieces will be components you can add into it.
|
5
8
|
|
@@ -9,11 +12,40 @@ Must define these environment variables:
|
|
9
12
|
|
10
13
|
- `EVERYTHING_PATH` - the full path to your everything repo.
|
11
14
|
|
15
|
+
## Installation
|
16
|
+
|
17
|
+
```
|
18
|
+
gem install everything-core
|
19
|
+
```
|
20
|
+
|
12
21
|
## Usage
|
13
22
|
|
23
|
+
This assumes you have a `EVERYTHING_PATH` environment variable either set in
|
24
|
+
your shell or in dotenv's `.env` file.
|
25
|
+
|
26
|
+
For example, let's assume you have the following folder and file under your
|
27
|
+
everything path
|
14
28
|
|
15
29
|
```
|
16
|
-
|
30
|
+
your-piece-here/index.md
|
31
|
+
|
32
|
+
# Your Piece Here
|
33
|
+
|
34
|
+
The rest of the content of your file...
|
35
|
+
|
36
|
+
```
|
37
|
+
|
38
|
+
To use the piece from IRB, you could do the following to get the piece's title
|
39
|
+
and content.
|
40
|
+
|
41
|
+
```
|
42
|
+
require 'everything'
|
43
|
+
|
44
|
+
piece_path = File.join(Everything.path, 'your-piece-here')
|
45
|
+
piece = Everything::Piece.new(piece_path)
|
46
|
+
|
47
|
+
piece.title # => "Your Piece Here"
|
48
|
+
piece.content # => "The rest of the content of your file...\n\n"
|
17
49
|
```
|
18
50
|
|
19
51
|
## License
|
data/everything-core.gemspec
CHANGED
@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
|
|
19
19
|
spec.require_paths = ["lib"]
|
20
20
|
|
21
21
|
spec.add_runtime_dependency "fastenv", "= 0.0.2"
|
22
|
+
spec.add_runtime_dependency "dotenv", "= 2.0.2"
|
22
23
|
|
23
24
|
spec.add_development_dependency "bundler", "~> 1.11"
|
24
25
|
spec.add_development_dependency "rake", "~> 10.4"
|
data/lib/everything/version.rb
CHANGED
data/lib/everything.rb
CHANGED
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: everything-core
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.0.
|
4
|
+
version: 0.0.2
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Kyle Tolle
|
@@ -24,6 +24,20 @@ dependencies:
|
|
24
24
|
- - '='
|
25
25
|
- !ruby/object:Gem::Version
|
26
26
|
version: 0.0.2
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: dotenv
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - '='
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: 2.0.2
|
34
|
+
type: :runtime
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - '='
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: 2.0.2
|
27
41
|
- !ruby/object:Gem::Dependency
|
28
42
|
name: bundler
|
29
43
|
requirement: !ruby/object:Gem::Requirement
|