english-lang 0.1.0 → 0.1.1

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.
Files changed (2) hide show
  1. package/README.md +28 -3
  2. package/package.json +3 -3
package/README.md CHANGED
@@ -96,10 +96,35 @@ my-app/
96
96
  ├── screens/ ← write your .eng files here
97
97
  │ ├── HomeScreen.eng
98
98
  │ └── ProductScreen.eng
99
- └── rn/ ← react native project
100
- ├── src/ ← compiled .tsx files go here
99
+ └── rn/ ← react native project (npx react-native init rn)
100
+ ├── src/ ← engc compiles .tsx here automatically
101
+ │ ├── HomeScreen.tsx
102
+ │ └── ProductScreen.tsx
101
103
  ├── ios/
102
- └── android/
104
+ ├── android/
105
+ └── package.json
106
+ ```
107
+
108
+ **Quick start:**
109
+
110
+ ```bash
111
+ # 1. Create your project
112
+ mkdir my-app && cd my-app
113
+ npm init -y
114
+ npm install --save-dev english-lang
115
+
116
+ # 2. Create the React Native app
117
+ npx @react-native-community/cli init rn
118
+
119
+ # 3. Create your screens folder
120
+ mkdir screens
121
+
122
+ # 4. Write .eng files in screens/
123
+ # 5. Watch and compile
124
+ engc watch screens/ --out rn/src/
125
+
126
+ # 6. In a separate terminal, run the app
127
+ cd rn && npx react-native run-ios
103
128
  ```
104
129
 
105
130
  ---
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "english-lang",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "The English (.eng) programming language compiler",
5
5
  "main": "./dist/index.js",
6
6
  "bin": {
@@ -10,8 +10,8 @@
10
10
  "dist"
11
11
  ],
12
12
  "scripts": {
13
- "build": "tsc",
14
- "dev": "tsc --watch",
13
+ "build": "tsc",
14
+ "dev": "tsc --watch",
15
15
  "prepare": "tsc"
16
16
  },
17
17
  "devDependencies": {