@faiezhares/source-code-highlighter 0.0.0-stage → 0.0.17-beta

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.
package/README.md CHANGED
@@ -1,3 +1,31 @@
1
- # Temporary Holding Version
1
+ # @faiezhares/source-code-highlighter
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ A command line tool to annotate source code with TODOs and to explore their contexts.
4
+
5
+ Introduction post: [Code annotation with @faiezhares/source-code-highlighter](https://todidoio.substack.com/p/code-annotation-with-todidoio)
6
+
7
+ Initial step post: [@faiezhares/source-code-highlighter | Where to start](https://todidoio.substack.com/p/todidoio-where-to-start)
8
+
9
+ ## Usages
10
+
11
+ ```bash
12
+ npx @faiezhares/source-code-highlighter@latest -- --root <project-src-root> --port <port>
13
+ ```
14
+
15
+ Example:
16
+
17
+ ```bash
18
+ npx @faiezhares/source-code-highlighter@latest -- --root src/ --port 3000
19
+ ```
20
+
21
+ ## Legal notice
22
+
23
+ This is an independent side project that I’ve been shaping and refining over the years.
24
+ It’s built gradually in some of my free time.
25
+
26
+ This software is provided as-is without warranty of any kind. It is proprietary and
27
+ confidential.
28
+
29
+ Unauthorized use, distribution, or reverse engineering is prohibited.
30
+
31
+ By using this app, you accept these conditions.
@@ -0,0 +1 @@
1
+ body{margin:0;font-family:-apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Oxygen,Ubuntu,Cantarell,Fira Sans,Droid Sans,Helvetica Neue,sans-serif;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}code{font-family:source-code-pro,Menlo,Monaco,Consolas,Courier New,monospace}