Browse Source

better package description

boB Rudis 9 months ago
parent
commit
965c76a235
No known key found for this signature in database
5 changed files with 26 additions and 16 deletions
  1. 4
    2
      DESCRIPTION
  2. 5
    2
      R/clandnstine-package.R
  3. 2
    2
      README.Rmd
  4. 11
    8
      README.md
  5. 4
    2
      man/clandnstine.Rd

+ 4
- 2
DESCRIPTION View File

@@ -8,8 +8,10 @@ Authors@R: c(
8 8
            comment = c(ORCID = "0000-0001-5670-2640"))
9 9
   )
10 10
 Maintainer: Bob Rudis <bob@rud.is>
11
-Description: Something something 'DNS. Something something 'TLS'. 
12
-    Something something 'getdns API/library'.
11
+Description: Methods are provided to query 'Domain Name System' ('DNS') stub 
12
+    and recursive resolvers for all 'DNS' resource record types using 'UDP', 
13
+    'TCP', and/or 'TLS' transport layers. 'DNS' query support is provided
14
+    by the 'getdns' (<getdnsapi.net>) C library.
13 15
 SystemRequirements: C++11; libgetdns v1.5.1 or higher
14 16
 URL: https://gitlab.com/hrbrmstr/clandnstine
15 17
 BugReports: https://gitlab.com/hrbrmstr/clandnstine/issues

+ 5
- 2
R/clandnstine-package.R View File

@@ -1,7 +1,10 @@
1 1
 #' Perform Secure-by-default 'DNS' Queries
2 2
 #'
3
-#' Something something 'DNS. Something something 'TLS'.
4
-#' Something something 'getdns API/library'.
3
+#' Methods are provided to query 'Domain Name System' ('DNS') stub
4
+#' and recursive resolvers for all 'DNS' resource record types using 'UDP',
5
+#' TCP', and/or 'TLS' transport layers. 'DNS' query support is provided
6
+#' by the 'getdns' (<getdnsapi.net>) C library.
7
+#'
5 8
 #'
6 9
 #' - URL: <https://gitlab.com/hrbrmstr/clandnstine>
7 10
 #' - BugReports: <https://gitlab.com/hrbrmstr/clandnstine/issues>

+ 2
- 2
README.Rmd View File

@@ -18,7 +18,7 @@ Perform Secure-by-default 'DNS' Queries
18 18
 
19 19
 ## Description
20 20
 
21
-Something something 'DNS. Something something 'TLS'.  Something something 'getdns API/library'.
21
+Methods are provided to query 'Domain Name System' ('DNS') stub and recursive resolvers for all 'DNS' resource record types using 'UDP',  'TCP', and/or 'TLS' transport layers. 'DNS' query support is provided by the 'getdns' (<getdnsapi.net>) C library.
22 22
 
23 23
 ## NOTE
24 24
 
@@ -35,7 +35,7 @@ I've gotten this running on macOS and Ubuntu 16.04. For the latter I had to ensu
35 35
 
36 36
 ## TODO/WAT
37 37
 
38
-I finally grok the getdns api so the package api is going to change wildly and fast. The default mode will be to perform queries using DNS over TLS but also supports UDP and TCP transports.
38
+I finally grok the getdns api so the package api is going to change wildly and fast. The default mode will be to perform queries using DNS over TLS but support is also provided for UDP and TCP transports and either stub or recursive resolvers.
39 39
 
40 40
 ## Why?
41 41
 

+ 11
- 8
README.md View File

@@ -11,8 +11,10 @@ Perform Secure-by-default ‘DNS’ Queries
11 11
 
12 12
 ## Description
13 13
 
14
-Something something ‘DNS. Something something ’TLS’. Something something
15
-‘getdns API/library’.
14
+Methods are provided to query ‘Domain Name System’ (‘DNS’) stub and
15
+recursive resolvers for all ‘DNS’ resource record types using ‘UDP’,
16
+‘TCP’, and/or ‘TLS’ transport layers. ‘DNS’ query support is provided
17
+by the ‘getdns’ (\<getdnsapi.net\>) C library.
16 18
 
17 19
 ## NOTE
18 20
 
@@ -37,7 +39,8 @@ extract it and `config`/`make`/`make install` (plus `ldconfig` after).
37 39
 
38 40
 I finally grok the getdns api so the package api is going to change
39 41
 wildly and fast. The default mode will be to perform queries using DNS
40
-over TLS but also supports UDP and TCP transports.
42
+over TLS but support is also provided for UDP and TCP transports and
43
+either stub or recursive resolvers.
41 44
 
42 45
 ## Why?
43 46
 
@@ -189,9 +192,9 @@ gdns_lib_version()
189 192
 ## [1] "2604:a880:800:10::6bc:2001" "104.236.112.222"
190 193
 
191 194
 (gdns_get_address(x, "yahoo.com"))
192
-##  [1] "2001:4998:58:1836::10" "2001:4998:58:1836::11" "2001:4998:c:1023::4"   "2001:4998:c:1023::5"  
193
-##  [5] "2001:4998:44:41d::3"   "2001:4998:44:41d::4"   "72.30.35.9"            "72.30.35.10"          
194
-##  [9] "98.137.246.7"          "98.137.246.8"          "98.138.219.231"        "98.138.219.232"
195
+##  [1] "2001:4998:44:41d::4"   "2001:4998:58:1836::10" "2001:4998:58:1836::11" "2001:4998:c:1023::4"  
196
+##  [5] "2001:4998:c:1023::5"   "2001:4998:44:41d::3"   "98.137.246.8"          "98.138.219.231"       
197
+##  [9] "98.138.219.232"        "72.30.35.9"            "72.30.35.10"           "98.137.246.7"
195 198
 
196 199
 (gdns_get_address(x, "yahoo.commmm"))
197 200
 ## character(0)
@@ -204,7 +207,7 @@ str(leno <- gdns_query(x, "lenovo.com", "txt"), 1)
204 207
 ## List of 5
205 208
 ##  $ answer_type   : int 800
206 209
 ##  $ canonical_name: chr "lenovo.com."
207
-##  $ replies_full  : int [1, 1:600] 165 144 129 128 0 1 0 8 0 0 ...
210
+##  $ replies_full  : int [1, 1:600] 192 224 129 128 0 1 0 8 0 0 ...
208 211
 ##  $ replies_tree  :'data.frame':  1 obs. of  7 variables:
209 212
 ##  $ status        : int 900
210 213
 ##  - attr(*, "class")= chr [1:2] "gdns_response" "list"
@@ -228,7 +231,7 @@ Yep. Advertising even in DNS `TXT` records (see item number
228 231
 | Lang | \# Files |  (%) | LoC |  (%) | Blank lines |  (%) | \# Lines |  (%) |
229 232
 | :--- | -------: | ---: | --: | ---: | ----------: | ---: | -------: | ---: |
230 233
 | C++  |        3 | 0.21 | 608 | 0.65 |         196 | 0.62 |      138 | 0.27 |
231
-| R    |       10 | 0.71 | 306 | 0.33 |          68 | 0.22 |      280 | 0.54 |
234
+| R    |       10 | 0.71 | 306 | 0.33 |          68 | 0.22 |      283 | 0.55 |
232 235
 | Rmd  |        1 | 0.07 |  19 | 0.02 |          51 | 0.16 |       97 | 0.19 |
233 236
 
234 237
 ## Code of Conduct

+ 4
- 2
man/clandnstine.Rd View File

@@ -6,8 +6,10 @@
6 6
 \alias{clandnstine-package}
7 7
 \title{Perform Secure-by-default 'DNS' Queries}
8 8
 \description{
9
-Something something 'DNS. Something something 'TLS'.
10
-Something something 'getdns API/library'.
9
+Methods are provided to query 'Domain Name System' ('DNS') stub
10
+and recursive resolvers for all 'DNS' resource record types using 'UDP',
11
+TCP', and/or 'TLS' transport layers. 'DNS' query support is provided
12
+by the 'getdns' (<getdnsapi.net>) C library.
11 13
 }
12 14
 \details{
13 15
 \itemize{

Loading…
Cancel
Save